-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor documentation navigation #11139
Conversation
This is an initial proof of concept of a concept-based TOC, instead of using Diataxis. This shows a lot more where we're missing various pieces of content, and overall I think really improves our documentation structure. A big benefit downstream of this is making our page titles more explicit, so users know what each page has on it. I've started doing this very lightly so you can get a sense, but it makes things way more clear.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great upgrade and the title changes helped a lot here. I don't feel we need to be too particular with the title changes otherwise. We can iterate on these later if we agree on overall structure. I'm sure the harder to change titles will require moving some content around or breaking pages up a little more.
/config-file/index | ||
/config-file/v2 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is great, having the related topics closer together makes it far easier to relate all of these topics 👍
I could see us in the future adding another navigation layer so we could group minor topics all relating to big features, ie:
- Project setup and configuration:
- Configuration file:
- Overview
- Examples
- Troubleshooting
- Reference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed. There's definitely scope for additional pages 💯
@@ -1,3 +1,5 @@ | |||
.. TODO: This is a super weird page.. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is. I feel like this should be application UI instead probably.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea, I've hidden it for now. I wanted to start with all the pages in a TOC, but I've now marked a few as orphans that I don't think we want to put in front of users quite yet.
Co-authored-by: Anthony <aj@ohess.org>
I like this structure 👍🏼 -- it's easier to read from a user/customer perspective. Just knowing "what do I need to do?" or "what I am having troubles with?" is enough to jump into the correct section 👍🏼 |
This is an initial proof of concept of a concept-based TOC,
instead of using Diataxis.
This shows a lot more where we're missing various pieces of content,
and overall I think really improves our documentation structure.
A big benefit downstream of this is making our page titles more explicit,
so users know what each page has on it.
I've started doing this very lightly so you can get a sense,
but it makes things way more clear.
📚 Documentation previews 📚
docs
): https://docs--11139.org.readthedocs.build/en/11139/dev
): https://dev--11139.org.readthedocs.build/en/11139/