Documentation

The documentation content type lets you build a nested, organized knowledge base — exactly like the manual you are reading now. Docs live under /docs on your site.

Sections and pages

Docs are organized as a tree:

  • A section is a folder. It groups related pages and appears as a heading in the docs sidebar. A section is not itself a page you click into — it is a label with children beneath it.

  • A doc page is an article. It has a title, a rich-text body, and a position in the tree. Its URL is built from its place in the tree — for example /docs/getting-started/quickstart.

You arrange the tree by setting each item's parent and sort order. The sidebar follows that order top to bottom.

Creating docs

Go to Content → Docs. Create a section first, then add pages under it. Set each page's order so the sidebar reads the way you want. Save a page as published to make it appear; drafts stay hidden.

Writing doc bodies

Doc bodies are rich text: headings, paragraphs, bold and italic, inline code and code blocks, bulleted and numbered lists, quotes, links, and images. Use headings to give each page a clear internal structure — the page title is rendered as the top-level heading automatically, so start your in-page sections one level down.

With the CLI or an agent

  • CLI — manage docs under the spideriq content command group.

  • MCP / agents — content_create_doc, content_docs_tree, and the doc update tools let an agent author and organize documentation. Because docs are a tree, an agent can create a whole section of pages and order them in one session.

Tips

  • Plan the tree first. A clear top-level set of sections (Getting Started, How-tos, Reference) makes the sidebar scannable.

  • Keep pages focused. One page per task or concept beats one giant page.

  • Cross-link. Link related docs to each other — readers rarely arrive at page one.

This manual is itself a SpiderPublish docs tree, kept in sync from source — proof that the docs system is production-ready for your own knowledge base.

Next steps