Skip to content

How these docs work

This site is Metrica’s internal knowledge base. It’s read-mostly: engineering writes and maintains it, everyone else reads.

  • Source: the docs-site/ folder in the metrica-platform repo.
  • Content: Markdown / MDX files under docs-site/src/content/docs/, grouped into engineering/, product/, sales/, marketing/.
  • Built with: Astro Starlight.
  • Hosted on: Cloudflare Pages at docs.metrica.vision.
  1. Add or edit a .md file in the right folder under src/content/docs/.
  2. Every file needs frontmatter with at least a title:
    ---
    title: My page title
    ---
  3. Preview locally: cd docs-site && bun run dev.
  4. Commit and push — the site rebuilds and redeploys.

New folders show up as sidebar sections automatically (they’re wired with autogenerate in astro.config.mjs).

  • One topic per page. Keep titles short — they become the sidebar label.
  • Link between pages with root-relative paths, e.g. [deploy](/engineering/deploy/).
  • Put images in src/assets/ and reference them with a relative path.