docs(site): UX, nav, and reference cleanup#53
Merged
Conversation
First of the docs-phase PRs. - Expand the spec mention on the homepage into a standalone section linking to openarmature.org (was a paragraph reference only). - Drop `navigation` from the homepage `hide:` list so the left nav renders on the landing page. - Make the "OpenArmature" wordmark clickable via a local override of Material's header partial. The homepage variant also suppresses the default wordmark/page-title scroll swap, which read as a render glitch when both texts are identical. - Add Parallel branches to the Concepts nav (proposal 0011 landed without it). - Refresh the Reference index: add openarmature.prompts; note parallel-branches, multimodal/structured output, and the state-migration registry on existing entries; drop the boilerplate trailer about underscored symbols.
There was a problem hiding this comment.
Pull request overview
Docs-site focused PR to improve navigation and header UX in the MkDocs Material site, plus small reference index cleanup, without changing the library source.
Changes:
- Enabled left navigation on the homepage and added “Parallel branches” to the Concepts nav.
- Added a Material header partial override so the “OpenArmature” wordmark links home and remains pinned on the homepage (no scroll-swap glitch).
- Refreshed the reference index blurbs and added the missing
openarmature.promptsentry.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Enables theme overrides and adds Concepts nav entry for parallel branches |
docs/stylesheets/extra.css |
Styles for clickable wordmark link and homepage header pinning behavior |
docs/reference/index.md |
Updates reference bullets/blurbs and adds openarmature.prompts |
docs/overrides/partials/header.html |
Material header override to make wordmark clickable and adjust homepage title swap behavior |
docs/index.md |
Shows homepage left nav and reworks the spec section content/link |
Comments suppressed due to low confidence (1)
docs/overrides/partials/header.html:47
- In this override,
config.site_nameis inserted into attributes/text without escaping (e.g.,aria-labelhere and the visible wordmark text below). Since this is user-configurable content, it should be HTML-escaped (e.g., apply| econsistently) to avoid broken markup and reduce injection risk.
<a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" class="md-header__topic md-header__topic-link" aria-label="{{ config.site_name }}">
<span class="md-ellipsis">
{{ config.site_name }}
</span>
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Header partial override: enumerate both local modifications in the top comment (was written when only the anchor wrap existed and not updated when the homepage pinning logic was added). Resync-on-bump guidance is the whole point of that comment, so it needs to list everything that must be preserved. - Homepage spec section: capitalize "OpenArmature" to match the page H1 and README convention; reserve the lowercase form for code spans referring to the Python package. Replace the em dash on the same line with a comma.
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
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.
Summary
First of the docs-phase PRs. Site UX, nav, and reference touch-ups; no source changes.
hide: [navigation]).openarmature.promptsbullet, refreshedgraph/llm/checkpointblurbs to mention features that shipped in 0.6.x (parallel-branches, multimodal + structured output, state-migration registry), and dropped a trailer paragraph that just restated Python's underscore convention.Test plan
uv run --group docs mkdocs build --strictsucceedsopenarmature.prompts