Documentation History

This page is the revision log of the documentation itself. Every time the documentation is (re)generated or substantially updated, a revision entry is appended below recording the commit of each source repository the content was derived from. That snapshot is the baseline for the next update: diff each repo from the recorded commit to HEAD to see exactly what changed and therefore which pages need updating.

The documentation site itself needs no separate reference — this page lives in the same repository as the docs, so the commit that introduces a revision entry is that revision’s identity.

How to update the documentation

The intended workflow — for a maintainer or an AI session asked to “update the documentation”:

1. Read the latest revision entry below and note the per-repo baseline commits.

2. Diff each source repo since its baseline:

   # platform repo (run from the repo root)
   git log --oneline --stat <baseline-sha>..HEAD
    
   # sibling repos
   git -C ../../../maxq-labs/trajectory-methodology log --oneline <sha>..HEAD
   git -C ../../solution-template log --oneline <sha>..HEAD
   git -C ../../solution-template-internal log --oneline <sha>..HEAD

3. Map the changes to pages using the table below — each documentation area lists the repo paths it is derived from. Only pages whose sources changed need rework. New memory/*.md topics and new designs/*.md files are a strong signal of new decisions or subsystems to document.

4. Update the affected pages (and the Design Decisions log if a new platform-shaping decision was recorded).

5. Append a new revision entry to this page: date, scope of the update, and the new HEAD commit of every source repo (short SHA, 12 chars: git rev-parse --short=12 HEAD).

6. Rebuild (npm run build) to validate MDX and refresh the search index.

Source map: which pages depend on which sources

Revision log

Entries are newest-first. Record short SHAs (12 chars) and the branch they were read from.

r4 — 2026-07-05 — Documentation-site deployment (the docs app)

Small follow-up: this documentation site itself gained a deployment chain — build-images.sh docs (image orbit-documentation, self-contained codebase context), the docs ACA app via provision-docs.sh / deploy.sh docs (app-docs.yaml.tmpl, external ingress, scale-to-zero), and a Cloudflare front door at documentation.<zone> (proxied CNAME + managed certificate + strict SSL; deliberately no edge-secret rule — public content, no edge guard). Pages changed: Infrastructure — Azure Deployment (scripts, build-images targets, front-door section). Sources: infrastructure/azure/ (provision-docs.sh, app-docs.yaml.tmpl, build-images.sh, deploy.sh, lib.sh, config examples), implementation/orbit-documentation/dockerfiles/. Source-repo baselines: unchanged from r3 apart from the platform repo, whose baseline is the commit introducing this chain (the r3 footnote’s convention applies unchanged).

r3 — 2026-07-05 — Platform activity feed (activity-service + @maxq/activity-kit)

Documented the new platform activity feed (designs/activity-service.md, v1): the fourth platform microservice activity-service — an append-only ActivityEvent store (ULID keys, typed filter columns + jsonb document, keyset-paginated feed API, per-item batch acceptance, no peers) on the shared portfolio database — and the @maxq/activity-kit fire-and-forget emitter (bounded queue, batched flush with retry/backoff, disabled no-op mode, withCorrelation). Producer integration and the Aurora “Flight Log” UI are explicitly still pending and marked as such.

Pages changed: Applications — Activity Service (new page + sidebar entry), Applications — Overview (feed bullet, inventory row for port 3024, shared-packages rows, next-steps link), Applications — Registry Services (audit-trail vs activity-feed cross-link), Infrastructure — Local Development (topology diagram, services table, build-context and migration notes, port list), Infrastructure — Azure Deployment (topology diagram svc-activity node, scripts and provisioning sections, fresh-env order). Sources: implementation/activity-service/, implementation/shared/activity-kit/, infrastructure/local/docker-compose.yml, infrastructure/azure/ (provision-services.sh, build-images.sh, app-service.yaml.tmpl, deploy.sh, lib.sh), designs/activity-service.md, memory/activity-service.md.

† The activity-service implementation itself was still uncommitted working-tree state at generation time — 4f331dc722fa is the parent commit. The maintainer’s commit introducing the feed (and this revision entry with it) is the real baseline for the next update.

r2 — 2026-07-05 — Solution-plane deployment engine (@maxq/orbit-deploy)

Documented the deployment-engine refactor (ADR-015): per-solution provisioning moved from the bash/TS twins into the single TypeScript engine implementation/shared/orbit-deploy — steps with plan/apply/verify modes, scenarios (deploy / redeploy-apps / frontdoor / storage / verify / teardown), structured StepResults, the registry deployment.lastRun run log, the in-product Cloudflare front door + edge lockdown, the conditional seed, the ACR image preflight (builds stay human), the ten agent deploy tools with confirm/typed-back gating, and the deploy.sh solution CLI. Bash keeps the platform plane; provision-solution.sh is marked legacy-until-proven.

Pages changed: Infrastructure — Azure Deployment (engine section, plane split, scenario table, verify/teardown rework), Applications — Aurora (auto-deploy summary, toolset table, double-gated teardown, config reference), Design Decisions (new ADR-015 + index row). Sources: implementation/shared/orbit-deploy/, infrastructure/azure/ (deploy.sh, provision-aurora.sh, app-aurora.yaml.tmpl), implementation/aurora-webapp/codebase/src/lib/{solutions,agent,registry}/, memory/orbit-deploy-engine.md.

† The engine refactor itself was still uncommitted working-tree state at generation time — e01b9662c227 is the parent commit. The maintainer’s commit introducing the refactor (and this revision entry with it) is the real baseline for the next update.

r1 — 2026-07-03 — Initial full generation

First exhaustive generation of the whole site: all Architecture, Applications, Infrastructure pages and the Design Decisions log, produced from the platform’s memory records, design docs, application code, and the methodology specification.

Scope notes: documentation reflects the platform state including the 2026-07-02 repo consolidation and agent-served-solution-data refactor, the 2026-07-03 registry production migration, the 2026-07-03 agent scale-to-zero model, and the 2026-07-03 move of the per-solution agent to internal-only ingress (no agent subdomain; Mission Control’s same-origin /agent proxy).