Structuring Documentation

DeveloperHub documentation index contains six elements:

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

Long Dragging

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.

Selecting Several Elements

Click an element, then hold Shift and click another to select everything between them. To pick elements one by one from anywhere in the index, hold Alt (Option on a Mac) and click each of them. On a Mac, Ctrl and click works too.

Drag the selection and it all moves together.

With two or more elements selected, click the menu on any of them to act on them all at once: Move, Re-arrange, Allow Publishing, Unpublish, Hide From Index, Show in Index or Delete. Move also copies them, to another section or to another version.

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.

Info

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


  Last updated