Documentation Navigation Panel
Last modified by Eleni Cojocariu on 2026/03/19 08:02
The documentation navigation is displayed in the left panel, as shown below:
The documentation interface includes two navigation panels:
- The target selector (left panel), which lets users choose the documentation target (e.g., Users, Admins, Developers).
- The content navigation panel, which changes dynamically based on the selected target.
Content navigation is achieved through the Document Tree macro, which automatically lists pages alphabetically.
- Top-level tree node pages must be pinned according to their usability, relevance, and importance within the documentation.
- Type landing pages are also be pinned in the Diataxis order, which is: Tutorial, How-to, Reference, Explanation.
- Documentation pages can be pinned where it makes sense (e.g., when some pages would appear first if there's no pinning and it would nicer for reader to see other pages listed first) and it's up to the documentation writer to take that decision.
