Structuring Documentation

DeveloperHub documentation index contains six elements:

All elements can be re-ordered by dragging and dropping them.

To re-order an element far away in the index, you can either:

  • Click on its menu, choose Re-arrange, then a category to send the element to its bottom.
  • Drag the element to the absolute top or absolute bottom of the index, the index will start scrolling automatically.

Index Depth

Index can be as hierarchical as needed. Categories and separators are top-level elements. All other elements can be placed as parent or child elements.

We recommend keeping your documentation index as flat as possible. It's good UX!

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
  Last updated by Zaid Daba'een