docs(docusaurus): move version dropdown to left navbar; shorten label to 'main'#1238
Open
planetf1 wants to merge 4 commits into
Open
docs(docusaurus): move version dropdown to left navbar; shorten label to 'main'#1238planetf1 wants to merge 4 commits into
planetf1 wants to merge 4 commits into
Conversation
… to 'main' Two navbar polish changes: - docsVersionDropdown moved from right (between Community and GitHub) to left (after API Reference), so it groups with content navigation rather than sitting between external links - current version label shortened from 'main (unreleased)' to 'main' for cleaner display in the dropdown Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> Assisted-by: Claude Code
github-actions
Bot
added
the
documentation
Contributor
|
could you include before and after screen shots? |
…tions - Update two 'main (unreleased)' references to 'main' to match the label change in docusaurus.config.ts - Expand the fork PR note into a full 'Previewing from your own fork' section covering the GitHub Pages bootstrap pattern (docs/staging workaround) and the fork baseUrl difference Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> Assisted-by: Claude Code
Before the first release snapshot exists, banner: 'unreleased' produces a circular "see latest version (main)" message. Set banner: 'none' until a real snapshot version becomes the default. Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> Assisted-by: Claude Code
Remove the docs/staging bootstrap step (peaceiris creates gh-pages automatically on first push) and the baseUrl explanation (handled transparently by the workflow). Signed-off-by: Nigel Jones <jonesn@uk.ibm.com> Assisted-by: Claude Code
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
1. Navbar version dropdown position
The version dropdown currently sits on the right side of the navbar, between Community and GitHub:
That position is confusing — it looks like an external link rather than a navigation control for the docs content. This PR moves it to the left side, immediately after API Reference:
2. Version label shortened to 'main'
The label
'main (unreleased)'is longer than needed for a navbar item. Shortened to'main'.3. PUBLISHING.md: stale label refs + fork preview docs
'main (unreleased)'that would have become stale after the label change above.docs/stagingworkaround needed whengh-pagesdoesn't exist yet) and the forkbaseUrldifference (/mellea/vs/).Notes
The
build-and-validateCI job builds the full Docusaurus site on every PR touchingdocs/, so any config error would be caught before merge.