Skip to main content

Summary

Use this page when you are changing navigation, writing new pages, updating existing guides, or deciding where new documentation should live.

Who this is for

Internal contributors maintaining the docs site and content standards.

Core contributor rules

  • keep user-facing docs centered on product workflows, not code structure
  • prefer stable product concepts over unstable route names
  • treat Communications as the main operating story for channel activity
  • keep future-facing developer docs honest about what is and is not public yet
  • keep the preserved Mintlify starter content clearly separated from real TruAgents docs

Before you add a new page

  • confirm the page belongs in the approved information architecture in docs.json
  • check whether the topic already fits inside an existing page instead of creating thin extra pages
  • make sure the title uses product language users will understand
  • link the page to adjacent setup, workflow, concept, or reference docs

Before you publish docs changes

  • verify that the page still matches the current product story
  • remove or rewrite placeholder wording if the page is now meant to be genuinely useful
  • confirm links and related-page sections still point to the strongest canonical docs
  • prefer plain English before technical detail

Simple version

Add pages only when they clarify the product, not just because the nav has room.