Skip to main content

Documentation project instructions

About this project

  • This is a documentation site built on the Devarno Atlas platform
  • Pages are MDX files with YAML frontmatter
  • Configuration lives in docs.json
  • Run npm run dev to preview locally
  • Run npm run build to create production build

Terminology

  • Use “Devarno Atlas” not “Mintlify” or “docs platform”
  • Use “documentation” not “docs site”
  • Use “projects” or “organizations” for top-level sections

Style preferences

  • Use active voice and second person (“you”)
  • Keep sentences concise — one idea per sentence
  • Use sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references

Content boundaries

  • Document all public-facing features and APIs
  • Include runbooks for operational procedures
  • Add architecture decision records (ADRs) as needed
  • Include quickstart guides for each product