Skip to content

Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012

Description

@JSONbored

Context

ORB's self-hosting story is fully documented on the real LoopOver docs website: apps/loopover-ui/src/routes/docs.self-hosting-*.tsx (quickstart, configuration, AI providers, backup/scaling, release checklist, troubleshooting, security — all linked from docs.index.tsx's "Maintainers" audience). AMS has no equivalent. Its operator-facing guides exist only as raw markdown inside packages/loopover-miner/DEPLOYMENT.md and 10 files under docs/ — never ported to the website, and never linked from the docs nav. Someone deploying/operating AMS today has to go find these files in the repo instead of finding them on the docs site the way an ORB operator would.

This was found during a 2026-07-15 audit of every .md file tracked in the repo (65 total), separating legitimate markdown (root meta files, package READMEs/CHANGELOGs, research/audit/RFC/design docs, test fixtures — all fine to stay as markdown) from genuine operator/user-facing guides that were committed as raw docs instead of website pages. The 11 files below are that second category, each verified by reading its actual content, not just its filename.

Scope

11 sub-issues, one per source file, each porting one guide into a new docs.ams-*.tsx page (following docs.self-hosting-quickstart.tsx's exact pattern: createFileRoute, head() meta/OG tags, <DocsPage> + Callout/CodeBlock/FeatureRow primitives from @/components/site/primitives), removing/stubbing the raw markdown source, updating any internal cross-references to the old file, and adding the new page to docs.index.tsx's nav:

  • #TBD1 — DEPLOYMENT.md → AMS deployment guide (laptop vs. fleet mode) — the largest one
  • #TBD2 — docs/operations-runbook.md → local-state recovery runbook
  • #TBD3 — docs/observability.md → Grafana/observability setup
  • #TBD4 — docs/unattended-scheduling.md → cron/systemd scheduling guide
  • #TBD5 — docs/sizing.md → CPU/RAM/disk sizing reference
  • #TBD6 — docs/config-precedence.md → config layer resolution order
  • #TBD7 — docs/env-reference.md → env var reference (generated by npm run miner:env-reference — needs a rendering approach, not a hand-copy; see that sub-issue)
  • #TBD8 — docs/discovery-plane-operator-guide.md → hosted discovery-plane operator guide
  • #TBD9 — docs/miner-goal-spec.md.loopover-miner.yml field reference
  • #TBD10 — docs/fleet-run-manifest.md → fleet-operator config reference
  • #TBD11 — BENCHMARKS.md → perf numbers (lower priority — evaluate whether this genuinely belongs on the public docs site or is better left as a repo-internal contributor artifact; do this one last, after the higher-confidence ones establish the pattern)

Deliberately excluded from this epic (verified during the same audit, staying as markdown): research spikes (ams-auth-identity-research.md, ams-storage-abstraction-research.md), audits (global-singleton-tenant-audit.md, telemetry-export-privacy-audit.md, repo-agnostic-capability-audit.md ×2), design/RFC docs (cross-repo-evaluation.md, cross-repo-discovery-phase1.md, docs-drift-audit-sweep-rfc.md, idea-intake-bridge-schema.md, coverage-safe-file-moves.md, iterate-loop-load-test.md), discovery-index-contract.md (still-provisional protocol contract), coding-agent-driver.md (contributor/architecture doc, not operator docs), miner-selfimprove-calibration.md (feature design spec), and CONVERGENCE_RUNBOOK.md (maintainer incident runbook — markdown is the right format for fast incident response).

Navigation plan

Add the new pages to docs.index.tsx. Given AMS operator concerns are genuinely distinct from the existing "Miners" audience (which covers doing miner work — branch analysis, scoreability — not deploying/operating the miner), propose extending the existing "Maintainers" audience's links with an AMS sub-group (mirroring how it already lists self-hosting-* ORB pages), rather than inventing a 6th audience card. The first sub-issue to land should make this call concretely and the rest follow its precedent — don't have 11 independent, inconsistent nav decisions.

Expected Outcome

Anyone deploying or operating AMS finds a complete, properly-organized guide on the LoopOver docs website, structurally parallel to what ORB operators already have — instead of having to dig through the repo for markdown files.

Links & Resources

  • apps/loopover-ui/src/routes/docs.self-hosting-quickstart.tsx (the pattern every sub-issue follows)
  • apps/loopover-ui/src/routes/docs.index.tsx (nav to extend)
  • packages/loopover-miner/DEPLOYMENT.md, packages/loopover-miner/docs/*.md, packages/loopover-miner/BENCHMARKS.md (the 11 source files)

Metadata

Metadata

Assignees

Labels

help wantedExtra attention is neededmaintainer-onlyOwner-only work — yields no Gittensor points.roadmapOn the Wave-2 agent-layer roadmap board (project 9)

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions