crate / cloud-docs

Documentation for CrateDB Cloud.
https://crate.io/docs/cloud/
Apache License 2.0
0 stars 1 forks source link

Select and/or adjust canonical toctree #18

Closed amotl closed 1 year ago

amotl commented 1 year ago

About

Details

On the preview page, and in this screenshot, you will see both toctree variants currently defined at cloud-docs:/docs/index.md.

image

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

amotl commented 1 year ago

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.

amotl commented 1 year ago

GH-24 will bring in more toctree fixes, as discovered by @matkuliak. Thanks.

amotl commented 1 year ago

For a first ramp-up, I think everything has been resolved on this matter. If you discover further flaws, please re-open.