How these docs work
This site is Metrica’s internal knowledge base. It’s read-mostly: engineering writes and maintains it, everyone else reads.
Where it lives
Section titled “Where it lives”- Source: the
docs-site/folder in themetrica-platformrepo. - Content: Markdown / MDX files under
docs-site/src/content/docs/, grouped intoengineering/,product/,sales/,marketing/. - Built with: Astro Starlight.
- Hosted on: Cloudflare Pages at
docs.metrica.vision.
Editing (engineering)
Section titled “Editing (engineering)”- Add or edit a
.mdfile in the right folder undersrc/content/docs/. - Every file needs frontmatter with at least a
title:---title: My page title--- - Preview locally:
cd docs-site && bun run dev. - 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).
Conventions
Section titled “Conventions”- 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.