Improve Page sorting in the Sidebar

dialogic-godot / documentation

📖 The documentation for the Dialogic Godot plugin.

http://docs.dialogic.pro

17 stars 12 forks source link

Improve Page sorting in the Sidebar #3

Closed Jowan-Spooner closed 9 months ago

Jowan-Spooner commented 10 months ago

Not sure how this is best implemented, but I feel the sorting is really arbitrary right now. We might want to have sections for step by step guides (like Getting Started) and info pages.

coppolaemilio commented 10 months ago

Yes! the current sidebar is random actually. What sections should we have?

Jowan-Spooner commented 10 months ago

It's a bit tricky as (right now) we have a couple of pages which don't perfectly fit one of these sections. But looking at the godot docs I'd say the ones we could need would be:

About
Guides/Tutorials
Manual/Documentation/Information
FAQ
If we manage to automate it: Class Reference (especially for autogenerated reference of Subsystems & Events)

CakeVR commented 9 months ago

Using mdBook, the SUMMARY.md file contains the actual navigation sidebar and decides how the links are displayed. Check out the current live website for a demonstration and take a look at the repository file.