Skip to content

Project Structure

The structure is intentionally simple.

text
docs/
  .vitepress/
    config.ts
    content.ts
    nav.ts
    sidebar.ts
    theme/
  getting-started/
  guides/
  api/
  integrations/
  deployment/
  troubleshooting/
  references/
  changelog/
  templates/
  assets/
  public/

Why this layout works

  • The top-level folders map to major documentation topics.
  • content.ts keeps nav and sidebar in one place.
  • The templates folder keeps reusable markdown patterns separate from live docs.
  • The references folder holds conventions and maintenance guidance.
  • The public folder stores static assets used by the site.

Markdown-first documentation for teams that update docs often.