Repository navigation
Show the version in the docs title and drop the version notes - #954
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation and banner-removal changes are consistent, with no unresolved blocking findings.
No open issues 🎉
What changed in this PR
The documentation now identifies its version in the site title instead of repeating version notes above code blocks.
Changes:
- Show the release version or “dev” in the documentation title and remove banner-rendering support.
- Add a launcher command reference and navigation links.
- Update documentation conventions and standardize page-title capitalization.
| File | Description |
|---|---|
| doc/sphinx_ext/fix_links/parser.py | Remove code-block banner rendering. |
| doc/sphinx_ext/fix_links/__init__.py | Remove banner configuration registration. |
| doc/scripts/recon_surfreg.rst | Standardize title capitalization. |
| doc/scripts/recon_surf.rst | Standardize title capitalization. |
| doc/scripts/LAUNCHER.md | Add launcher usage reference. |
| doc/scripts/index.rst | Include the launcher reference. |
| doc/scripts/advanced.rst | Standardize title capitalization. |
| doc/overview/OUTPUT_FILES.md | Standardize title capitalization. |
| doc/overview/install/NATIVE.md | Standardize title capitalization. |
| doc/overview/CONTAINERS.md | Shorten title and link launcher reference. |
| doc/developer/GIT-HOOKS.md | Standardize title capitalization. |
| doc/developer/docker.rst | Standardize title capitalization. |
| doc/CONVENTIONS.md | Document the title-based version convention. |
| doc/conf.py | Set versioned titles and remove banner settings. |
| doc/AGENTS.md | Remove the banner-rendering description. |
Review effort: Balanced
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.
The title at the top left (and in the browser tab) now says which version a tree documents: "FastSurfer " for the stable docs, "FastSurfer dev" for the development docs. The notes above code blocks with image versions (44 in the dev docs, 18 in the stable docs, e.g. "This documents the development version ... Official Docker images only exist for releases") are removed, together with the fix_links code that rendered them: the title and the announcement bar already say which version a page documents. The conventions are updated to match.