Navigator documentation index

This is the front door for humans and LLM agents. Top-level files in docs/ are published on the website at /docs/<slug>; nested files stay repo-local unless another page links to them.

Read glossary.md before using domain words. Read access-model.md before making claims about client, staff, admin, or project participation. Read agent-decision-councils.md before using the Engineering, Legal, or Client Council review patterns.

How this index works

• Start with the task. Use the sections below to find the workflow, system, or integration you are touching.
• Confirm the vocabulary. Use Glossary quick links for the core nouns, then jump to glossary.md for the full definition.
• Follow the most specific doc. If two docs overlap, prefer the doc closest to the thing being changed, and keep the broader doc as orientation.
• Keep links descriptive. Link to the page or heading that answers the reader's actual question.

Glossary quick links

These are the terms agents most often need before making a decision. The full alphabetical reference is glossary.md; notation-specific vocabulary is in notation.md.

• AIDA — domain agent persona and protocol bridge. See aida-a2a-interaction.md and gemini-enterprise-mcp.md.
• Blob — stored bytes behind cloud::StorageService. See cloud-operations.md and git-project-repos.md.
• Council / Counsel — decision councils and attorney spelling. See agent-decision-councils.md.
• ctx.run — Restate journaled side-effect primitive. See durable-workflows.md and agent-workflows.md.
• Document — project-scoped reference to a Blob. See gov-forms.md and docusign-esignature.md.
• Engagement / Retainer — client-English name for a running Notation. See retainer_intake.md and notation-authoring.md.
• Participation — per-project scope row, not system role. See access-model.md and oidc.md.
• Person / Entity — human and legal-organization nouns. See bulk-contact-import.md and access-model.md.
• Project — matter container. See git-project-repos.md and nautilus-workflows.md.
• Workflow Runtime — durable runtime model. See durable-workflows.md and cronjobs.md.

Agent operating model

• agent-workflows.md — the two codebase actions: create a PR, or review/update an existing PR. Preparation, GitOps, Markdown lint, Restate, and workflow authoring are supporting checks inside those actions.
• agent-decision-councils.md — Engineering Council, Legal Council, Client Council.
• cloud-operations.md — local dev, GCP setup, deploy, prod DB, spend, observability.
• rust-programming.md — Rust language conventions, async, Axum, SeaORM, service lifecycle.

Vocabulary and access

• glossary.md — workspace vocabulary.
• notation.md — notation-system vocabulary.
• access-model.md — role + participation authorization model.
• oidc.md — OpenID Connect login and role loading.
• i18n.md — English-first rule and the two allowed localization surfaces.

Workspace and development

• workspace-layout.md — crate map.
• RUNBOOK.md — local KIND runbook.
• test-database.md — test Postgres model.
• env-driven-devx.md — env-var-driven dev and deploy surfaces.
• secrets-doppler.md — Doppler and secret handling.
• editing-workflows.md — editing notation templates.
• notation-authoring.md — authoring notation templates.
• lsp/README.md — editor integrations for notation diagnostics.

Shipping and operations

• gitops.md — branch, PR, release tag, deploy.
• gke-prod.md — GKE production architecture.
• oss-install.md — installing Navigator on your own cloud.
• multi-cloud.md — AWS, Azure, and self-hosted sketches.
• observability.md — logs, traces, metrics, and the no-content rule.
• durable-workflows.md — Restate durable execution and operations.
• cronjobs.md — scheduled jobs.
• deploy/gke-power-push-example.md — deploy walkthrough example.

Legal workflows and documents

• retainer_intake.md — retainer intake state machine.
• northstar-estate-flow.md — estate-planning flow.
• nautilus-design.md — Nautilus design.
• nautilus-workflows.md — Nautilus workflow details.
• gov-forms.md — government form provenance.
• docusign-esignature.md — DocuSign e-signature.
• solana-attestation.md — on-chain attestation.
• erd.md and erd.svg — database relationship diagram.

Data, billing, and integrations

• aida-a2a-interaction.md — AIDA, A2A, and MCP interaction.
• gemini-enterprise-mcp.md — Gemini Enterprise MCP integration.
• bulk-contact-import.md — bulk contact import payloads.
• email-events-pipeline.md — inbound/outbound email events.
• git-project-repos.md — per-Project git repositories.
• iceberg-archive.md — archive export.
• recurring-billing.md — recurring billing.
• third-party-integrations.md — vendor account convention.
• xero-billing.md — Xero billing.