Skip to content

Naming Conventions

Files and folders

  • Use lowercase kebab case for Markdown files.
  • Keep folder names short and semantic.
  • Use index.md for section landing pages.
  • Put reusable examples in templates.

Page titles

  • Use sentence case for page titles.
  • Keep titles specific.
  • Match the title to the page's intent.

Headings

  • Use one h1 per page.
  • Use h2 for major sections.
  • Use h3 for subtopics only when needed.

Markdown-first documentation for teams that update docs often.