The documentation site
For authorized editors who publish POM product documentation. This chapter covers the complete route from a production-safe Markdown source to a reviewed public documentation post.
In this chapter
| Topic | Article |
|---|---|
| Importing and updating from Markdown | Sync docs from Markdown |
| Finding and manually ordering documents | The Docs library |
| The reader's navigation | Documentation navigation shortcodes |
| Rendering a Markdown file on a page | The Markdown to HTML shortcode |
Who this chapter is for
People who maintain the documentation source or the dedicated documentation site. Synchronization is available only on that site and only to users with the required document and category permissions. If you are reading documentation rather than publishing it, nothing in this chapter applies to you.
How the pieces fit
- Product documentation is written as public Markdown in each product repository, organized into numbered topic directories with a complete manifest.
- Sync docs validates those files and creates or updates a documentation post for each one, with categories that mirror the directory structure.
- An editor reviews new drafts and affected published pages before making the result public.
- The Docs library gives editors a hierarchy-first view, with drag-and-drop ordering for documents that are not managed from Markdown.
- The navigation shortcodes build the product menu, page index and product call to action readers see.
The manifest is authoritative for order. That single fact resolves most confusion about why a manual reordering did not stick.
The division of labor
| Decided by | What |
|---|---|
| The product's Markdown and manifest | Which synchronized documents exist, their content and their order |
| The Docs library | Manual order for documents with no Markdown source |
| The shortcodes and the theme | How readers navigate and read |
Editing a synchronized document's content in WordPress is not the way to change it — the next synchronization overwrites it. Change the Markdown.
Recommended workflow
- Run Sync docs from Markdown.
- Review the synchronization summary and every new draft.
- Inspect the result in The Docs library.
- Confirm navigation, links and images on the public site.