Fix docs sidebar navigation and streamline Hextra site#2
Merged
Conversation
Improve the Hextra documentation site UX and navigation: - Cascade `type: docs` from the home page so single pages (each ADR, Metrics, Alternatives) keep the left navigation sidebar instead of falling back to Hextra's centered, sidebar-less single layout. This was the main pain point: opening an ADR dropped the ADR list. - Add a footer copyright via i18n/en.yaml. - Emit an llms.txt outline (home output format) plus a site description for its summary line. - Hide the adr-0000 template from the sidebar and llms.txt (it is the copy-me scaffold, still reachable from the Conventions link). - Order Alternatives last in the sidebar (weight 40). - Trim the navbar: drop the ADRs item, rename Documentation to Home.
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
1 participant
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 & why
Several UX fixes for the Hextra docs site (
docs/). The main issue: opening anindividual ADR dropped the left navigation sidebar, so there was no way to move
between ADRs — reported from the published site.
Changes
type: docsfrom the home pageso every descendant (each ADR, Metrics, Alternatives) uses Hextra's docs
layout with the left nav tree, instead of falling back to the centered,
sidebar-less single layout. The home landing page keeps its cards (cascade
does not apply to the page declaring it).
docs/i18n/en.yaml.descriptionused as itssummary line.
adr-0000-templateis excluded from thesidebar and llms.txt (already out of search). It stays reachable from the
Conventions link in the ADR index.
weight: 40).ADRsitem and renamedDocumentationtoHome. ADRs remain reachable via the sidebar and the home page card.