use hierarchical toc tree & remove redundant doc title anchors/refs #2
Conversation
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
Move the development, governance, archive-administration articles to a hierarchical structure. This has the benefit that it is visually easier to navigate the articles, because they are grouped and the groups can be toggled to not display. Signed-off-by: Dominik Viererbe <dominik.viererbe@canonical.com>
Collaborator
Please do drop this change. Using {ref} is always preferable to using {doc}, since ref doesn't rely on specifying a path (which can change if files move). |
dviererbe
force-pushed
the
feat/hierarchical-toc-tree
branch
from
ccc381e to
82ee673
Compare
s-makin
approved these changes
Apr 24, 2025
Collaborator
s-makin
left a comment
s-makin
left a comment
There was a problem hiding this comment.
Thanks for restoring the anchors - I expect that many of these pages will be changed/moved/removed/etc when we start to actually migrate content, but I do agree that having the collapsible topics makes the navigation much cleaner. Especially once people start using these docs and become familiar with the conceptual boundaries between the topics.
+1 from me, thanks for doing it :)
Collaborator
Author
|
Thanks for the SUPER fast review! ❤️ |
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.
This PR moves the development, governance, archive-administration articles to a hierarchical structure. This has the benefit that it is visually easier to navigate the articles, because they are grouped and the groups can be toggled to not display.
Without hierarchical toc tree (current state):
With hierarchical toc tree (this PR):
Additionally this PR removes the anchor/ref markers of article titles. They are not need, because documents can always be referenced by path using the following syntax:{doc}/path/to/documentor{doc}Custom link text </path/to/document>See also: https://github.com/canonical/sphinx-docs-starter-pack/blob/f0723d2831d061a98737c7297598287cb59f805f/docs/reference/doc-cheat-sheet-myst.md?plain=1#L68-L69In case the article title anchors are wanted, I grouped this change in a separate commit and I can simply drop it.EDIT: on request of TA I dropped the article title anchors removal