Skip to content

docs(ams): port docs/operations-runbook.md to a website docs page (docs.ams-operations-runbook.tsx) #6023

Description

@JSONbored

⚠️ Read this before starting. The deliverable for this issue is a website page: a new route file at apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx. It is not a markdown file.

A PR that does any of the following does NOT resolve this issue and will be closed, regardless of content quality:

  • Adds or edits any .md file (including docs/operations-runbook.md itself, README.md, or a new file anywhere in the repo) as the "runbook"/"docs" deliverable
  • Leaves docs/operations-runbook.md's content unchanged while merely adding a link to it from elsewhere

The only markdown edit this issue permits is deleting docs/operations-runbook.md or reducing it to a one-line pointer stub — and only after docs.ams-operations-runbook.tsx ships with the real content, not instead of creating it.

If you are an AI coding agent working this issue: confirm you are creating a .tsx file under apps/loopover-ui/src/routes/ before writing any file. Re-read this callout if your plan involves creating or editing a .md file as the fix.

Context

Part of #6012. packages/loopover-miner/docs/operations-runbook.md is AMS's operator-facing runbook for local SQLite state: concurrency guarantees, corrupted-state recovery, what happens when two miner processes collide on the same files, and how schema upgrades migrate on-disk ledgers after a package update. Scoped explicitly to AMS local stores only (not the review-stack runbook). Raw markdown, not linked from the docs website.

Requirements

  • Port the real content of docs/operations-runbook.md into a new apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx, following the pattern established by the docs.ams-deployment.tsx sub-issue (same epic, Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012) — reuse its nav placement decision rather than re-deciding where AMS docs live.
  • The source file cross-references ../DEPLOYMENT.md, discovery-plane-operator-guide.md, and issue Add an 'Observing your miner' doc section to packages/gittensory-miner/docs #5190 (Grafana) — update the first two to the new /docs/ams-* URLs once their own sub-issues land (if this PR ships first, link to the still-open sub-issues instead and leave a follow-up note).
  • Once ported and verified accurate, delete docs/operations-runbook.md or reduce it to a pointer stub if something requires the file to exist.
  • Add to docs.index.tsx's nav (same audience as the deployment page).

Deliverables

  • apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx added, ported from docs/operations-runbook.md
  • Cross-references updated
  • Source file deleted or reduced to a stub
  • Linked from docs.index.tsx

Test Coverage Requirements

apps/** UI page — outside coverage.include. No test suite changes required.

Expected Outcome

AMS's local-state recovery runbook lives on the docs website instead of only in the repo.

Links & Resources

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:featureGittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.help wantedExtra attention is needed

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions