Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add query strings to tabs #2840

Merged
merged 1 commit into from
Feb 26, 2025

Conversation

caksoylar
Copy link
Contributor

Apparently docusaurus tabs support query strings, which lets you persist the selected tab to the URL: https://docusaurus.io/docs/markdown-features/tabs#query-string. I think this will be useful to share links to the docs where we can point to the right tab value, so I added it in most places that tabs are used -- skipped a few that didn't seem necessary.

Note: when value of queryString is skipped it falls back to using groupId, so I preferred that whenever the latter exists.

@caksoylar caksoylar requested a review from a team as a code owner February 25, 2025 21:59
@caksoylar caksoylar added the documentation Improvements or additions to documentation label Feb 25, 2025
@caksoylar caksoylar force-pushed the docs/tab-query-strings branch from f0827d5 to 3db0f35 Compare February 25, 2025 22:28
Copy link
Contributor

@Nick-Munnich Nick-Munnich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this. I haven't checked whether there were any missed tabs, but I like the look of the preview and haven't noticed any issues scanning the commit details.

@caksoylar
Copy link
Contributor Author

caksoylar commented Feb 26, 2025

For reference, I think I only skipped https://zmk.dev/docs/features/modules#examples and https://zmk.dev/docs/development/new-behavior#submitting-a-pull-request among the ones I could find.

@caksoylar caksoylar merged commit d2eb6de into zmkfirmware:main Feb 26, 2025
7 checks passed
@caksoylar caksoylar deleted the docs/tab-query-strings branch February 26, 2025 00:32
Nick-Munnich pushed a commit to Nick-Munnich/zmk that referenced this pull request Feb 27, 2025
Nick-Munnich pushed a commit to Nick-Munnich/zmk that referenced this pull request Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants