-
Notifications
You must be signed in to change notification settings - Fork 1
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
Select and/or adjust canonical toctree #18
Comments
GH-19 and GH-21 added some additional strokes on the primary navigation. After rendering, https://crate.io/docs/cloud/ now has the latest version. Feel free to add any toughts of you about it, and how to eventually improve further. |
GH-24 will bring in more toctree fixes, as discovered by @matkuliak. Thanks. |
For a first ramp-up, I think everything has been resolved on this matter. If you discover further flaws, please re-open. |
About
crate-docs-theme==0.29.0
has been released, including the updates to the primary navigation coming from Install consolidated Cloud Docs, and edit primary navigation section in left sidebar crate-docs-theme#391.Details
On the preview page, and in this screenshot, you will see both toctree variants currently defined at cloud-docs:/docs/index.md.
The bottom section reflects the previous physical structure "Reference vs. Tutorials vs. How-To Guides", and the top section is made of a handcrafted toctree, which is reflecting the same structure and the order of the items from the "Manage" section of that page, directly referencing corresponding sections of the documentation, no matter where they are located.
Q&A
On this matter, I am asking which variant you would prefer? I think the handcrafted version has a point, while the other one, based on the previous physical structure, will be dissolved anyway in the course of the next iterations? Let me know if you have a different opinion, or other suggestions about this layout/design/structure/UX detail.
/cc @kojinkai, @SStorm, @matkuliak, @msbt
The text was updated successfully, but these errors were encountered: