Skip to main content

Tailboom Help Documentation Starter Pack

This directory is the source of truth for end-user docs under core.help.

Primary partition:

  • admin-portal
  • operator-app
  • pilot-life

Each app has three doc lanes:

  • product-guides
  • how-to
  • support-kb

Required Frontmatter​

Published docs should include:

  • id
  • title
  • app
  • doc_type
  • module_slug
  • roles
  • summary
  • owner
  • last_verified

Use templates from docs/help/_templates.

Automation​

Generate the catalog and implementation evidence:

npm run docs:help:catalog

Generated outputs:

  • docs/help/catalog/content-index.json
  • docs/help/catalog/implementation-index.json

Suggested Publishing Tooling​

Preferred:

  • Docusaurus (navigation + toolbar + search + versioning)

Alternative:

  • MkDocs Material (fast setup and strong markdown experience)