Flow

Using this portal

Search, navigation, source links, and glossary conventions in the documentation app.

  • Tabs at the top map to root sections in content/docs/ (Start Here, Platform, Projects, …).
  • Sidebar order within a section comes from each folder's meta.json.
  • Projects are grouped by domain in projects.json; adding a registry entry surfaces a new silo on the home page and project index without changing layout code.

Press ⌘ K (or use the search box). The index is built from compiled MDX at build time via Orama — no external search service.

<SourceLink path="services/template/cmd/api/main.go" /> renders a monospace path that opens the file on Azure DevOps at the repository default branch. Paths are repository-root-relative.

Glossary

Definitions live only in frontend/docs-app/src/glossary.ts. Use <Term id="transactional-outbox" /> at the first meaningful mention on a page, then plain text afterward. A misspelled id fails the build.

Authoring

See Documentation for MDX components, frontmatter requirements, and the rule that secrets never appear in pages.

Local development

Start Postgres and RabbitMQ, migrate, seed principals, and run Go services natively.

On this page

NavigationSearchSource linksGlossaryAuthoring