Docs

Read and navigate the library

Open Docs to browse the library. Its navigation has top-level sections and optional subsections. Each doc appears in one location, either directly in a section or in one of its subsections.

Within an article, the page outline links to its second- and third-level headings. Previous and Next links follow the library’s article order. Use Search when you know the topic but not its location.

Every published doc is available to everyone admitted to the installation. Sections organize the library; they do not create private areas or separate reader permissions.

Create and publish a doc

Contributors and Administrators can write and publish Docs.

1. Open Account menu, then Manage content or Manage organization. In Content, select Doc.
2. Enter a title that names the subject or task. Write the reference material in the body.
3. In Details, add the Short description. Readers see this summary above the body.
4. Under Docs section, search for and select one destination. Select the top-level section itself to place the doc directly there, or select a subsection for a more specific location.
5. Resolve the items under Before publishing, then select Publish.
6. Open Docs and check the article’s location, headings, links, and reader presentation.

If there are no sections, an Administrator must create the first one. Contributors can choose existing destinations, but cannot create or reorganize the navigation tree.

The editor explains formatting, autosave, publication, and recovery. For Docs, Heading 2 and Heading 3 are especially useful because they give readers a navigable outline.

Keep reference material current

Edit the existing doc when its subject remains the same. This keeps its link useful for readers and for other articles that refer to it. Save the revised draft, then publish when the replacement guidance is ready.

A doc’s URL identifies the article rather than its title or section path. Renaming it or moving it within the library does not require a new article URL. Links to individual headings do depend on the headings: check those links when changing a heading’s wording.

To keep a text copy, open the doc in the editor and select More editor actions → Download Markdown. This downloads the body currently in the editor. It does not bundle the article’s metadata or uploaded media.

Organizing the library — Administrators

Open Manage organization → Docs navigation to arrange the library. Navigation changes are staged until you save them.

Create sections and subsections

1. Select New section and enter New section name.
2. Leave Top-level parent at No parent for a top-level section, or select a top-level parent to create a subsection.
3. Select Create section, then Save settings to apply the navigation changes.

You can also use Add subsection from a top-level section’s actions. Subsections cannot contain another level of subsections.

An Administrator writing a doc can create a destination from Details → Docs section → Create section. That control creates the section and selects it for the doc; publication of the article remains a separate step.

Order and move articles

Expand a section to see its articles and subsections. Use drag handles or the actions menu’s Move up and Move down controls to reorder items. Use Move to… to choose a different destination.

A parent section can contain articles of its own as well as subsections. Moving a section keeps its documents attached; moving a doc changes that doc’s single navigation location. Review the resulting paths, then select Save settings.

These navigation changes apply to the library separately from publishing an article’s draft text. After saving, check Docs to confirm the intended order and placement.

Rename or remove a section

Use the section’s actions to rename it. Delete section is available for empty sections; unpublish or move articles from the section or sub-section before removing it. Save settings to apply the change.

Choose section names that help readers predict the material inside them. A shallow, clear structure is more useful than placing every article in its own subsection.