Skip to Content
ContributeDocs Standards

Docs Standards

Every StackLab documentation page should:

  • answer one primary question clearly
  • use a meaningful title and description
  • prefer technical clarity over hype
  • use root-relative links
  • stay short and sectional unless it is explicitly a deep reference page

Documentation Rules

  • apps/docs/content is the canonical docs source
  • public docs copy should stay aligned across docs pages, shared snippets, and the main web surface
  • hidden pages are allowed for maintainer and AI context
  • repeated language should use shared snippets when practical

Page Shape

Use this order unless a page truly needs a different one:

  • what this page answers
  • why it matters
  • key sections or categories
  • links to related pages
Last updated on