Skip to content

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

Merged
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-operations-runbook-6023
Jul 16, 2026
Merged

docs(ams): port docs/operations-runbook.md to a website docs page (docs.ams-operations-runbook.tsx)#6318
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-operations-runbook-6023

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Summary

  • Adds content/docs/ams-operations-runbook.mdx porting packages/loopover-miner/docs/operations-runbook.md to the website: SQLite concurrency guarantees (busy_timeout), the two-miners-collided and ledger-corruption recovery scenarios, backup/restore tooling, and post-upgrade schema migration — rendered via the existing DocsPage/Callout/CodeBlock/FeatureRow ui-kit primitives, following the pattern set in PR #6312 (docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6022).
  • Adds apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx, a thin loader + docsClientLoader route matching every other migrated docs page.
  • Adds the page to docs-nav.tsx's "AMS: deployment" subgroup (alongside the deployment guide) and to docs.index.tsx's Maintainers audience card.
  • packages/loopover-miner/docs/operations-runbook.md stays as the canonical source: it ships inside the published @loopover/miner npm package (check-miner-package.test.ts requires every docs/*.md) and its content is directly asserted by miner-operations-runbook.test.ts. A short pointer to the new website page was added at the top.

Scope

Validation

  • git diff --check
  • npm run actionlint
  • npm run typecheck
  • npm run test:coverage locally — UI-only page addition under apps/loopover-ui/** (outside coverage.include); codecov/patch does not apply
  • npm run test:workers
  • npm run build:mcp
  • npm run test:mcp-pack
  • npm run ui:openapi:check
  • npm run ui:lint
  • npm run ui:typecheck
  • npm run ui:build
  • npm audit --audit-level=moderate
  • Full npm run test:ci run locally from a clean npm ci install (verifying the fumadocs-mdx postinstall fix from fix(ui): generate fumadocs-mdx collections/* via postinstall #6310 holds), green: 894 test files / 17,168 tests passed
  • Targeted re-run of miner-operations-runbook.test.ts and check-miner-package.test.ts — pass unchanged

Safety

  • No secrets, wallet details, hotkeys, coldkeys, user PATs, private keys, raw trust scores, private rankings, or private maintainer evidence are exposed.
  • Public GitHub text stays sanitized, low-noise, and does not imply compensation guarantees or optimization tactics.
  • Auth, cookie, CORS, GitHub App, Cloudflare, or session changes include negative-path tests. — N/A, no such changes in this PR
  • API/OpenAPI/MCP behavior is updated and tested where needed. — N/A, no API/OpenAPI/MCP behavior changed
  • UI changes use live API data or real empty/error/loading states, not production mock/demo fallbacks. — N/A, static docs content only
  • Public docs/changelogs are updated where needed; changelogs are only edited for release-prep PRs.

Notes

@oktofeesh1
oktofeesh1 requested a review from JSONbored as a code owner July 16, 2026 01:31
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

…cs.ams-operations-runbook.tsx)

Add content/docs/ams-operations-runbook.mdx covering SQLite concurrency
guarantees, the two-miners-collided and ledger-corruption recovery scenarios,
backup/restore tooling, and post-upgrade schema migration -- rendered via the
existing DocsPage/Callout/CodeBlock/FeatureRow primitives. Add the page to
docs-nav.tsx's "AMS: deployment" subgroup (alongside the deployment guide) and
to docs.index.tsx's Maintainers audience card.

packages/loopover-miner/docs/operations-runbook.md stays as the canonical
source (ships inside the published @loopover/miner package; its content is
asserted by miner-operations-runbook.test.ts) with a short pointer added to
the new website page.
@oktofeesh1
oktofeesh1 force-pushed the docs/ams-operations-runbook-6023 branch from f5086c0 to 97bcf06 Compare July 16, 2026 01:35
@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 16, 2026
@loopover-orb

loopover-orb Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Tip

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-16 01:41:53 UTC

6 files · 1 AI reviewer · no blockers · readiness 82/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This PR mirrors the established docs-migration pattern (PR #6312) by porting the loopover-miner operations runbook to an MDX docs page, wiring a thin TanStack Router route, and adding nav entries in docs-nav.tsx and docs.index.tsx, plus a pointer comment back in the canonical markdown source. The route file, generated routeTree.gen.ts diff, and nav wiring all look internally consistent and match the shape of neighboring routes (e.g. docs.ams-deployment). The MDX content is a faithful, well-structured port with no obvious factual drift from the described source content.

Nits — 6 non-blocking
  • This is a UI-only docs page addition with no test-path changes; confirm that's acceptable per this repo's coverage exclusions for apps/loopover-ui/** as stated in the PR's validation checklist.
  • apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx:6 — the comment referencing 'docs-source.ts's comment for why the loader below resolves only a plain, serializable path string' assumes reader familiarity; a one-line inline rationale would be more self-contained if docs-source.ts isn't nearby.
  • The og:url and canonical href in docs.ams-operations-runbook.tsx are hardcoded absolute paths — verify this matches the convention in sibling route files rather than being derived from a shared constant.
  • Double check apps/loopover-ui/content/docs/ams-operations-runbook.mdx renders correctly in the docs site build (ui:build was run per checklist) especially the FeatureRow and Callout components with the longer prose blocks.
  • Confirm the routeTree.gen.ts diff is genuinely auto-generated (via the route generator) rather than hand-edited, since generated-artifact drift is a common source of subtle route-table bugs.
  • Code changes lack test evidence — Add focused regression tests or explain why existing coverage is sufficient.

Decision drivers

  • ✅ Code review — No blockers (1 reviewer)
  • ✅ Gate result — Passing (No configured blocker found.)
Context & advisory signals — never blocks the verdict
Signal Result Evidence
Linked issue ✅ Linked #6023
Related work ⚠️ 3 scoped overlaps Top overlaps are listed below; lower-confidence bulk is hidden.
Change scope ❌ 8/20 High review scope from cached public metadata (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 58 registered-repo PR(s), 47 merged, 1 issue(s).
Contributor context ✅ Confirmed Gittensor contributor oktofeesh1; Gittensor profile; 58 PR(s), 1 issue(s).
Improvement ℹ️ None detected risk: low · value: none · LLM: moderate
Linked issue satisfaction

Not yet addressed
The issue's explicit, non-negotiable requirement is a route file at apps/loopover-ui/src/routes/docs.ams-operations-runbook.tsx containing the ported content, with the source .md deleted or reduced to a stub only after the .tsx ships the real content; instead the PR keeps the .md as the 'canonical source' and puts the actual runbook content in a new content/docs/ams-operations-runbook.mdx file, wh

Review context
  • Author: oktofeesh1
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: JavaScript, MDX, Python, TypeScript
  • Official Gittensor activity: 58 PR(s), 1 issue(s).
  • Related work: Titles/paths share 6 meaningful terms. (issue #6025)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6031)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6027)
  • Additional title-only matches omitted; title-only overlap does not block.
Contributor next steps
  • Start here: Review top overlaps.
  • Then work through the remaining 2 steps in the Signals table above.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.
🧪 Chat with LoopOver

Ask LoopOver a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @loopover ask <question> answers contribution-quality Q&A with source citations and freshness.
  • @loopover chat <question> answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @loopover mention with a real question is routed to the closest matching read-only command automatically — no exact syntax required.

Full command reference: https://gittensory.aethereal.dev/docs/loopover-commands

🧪 Experimental — new and may change.

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.

  • Re-run LoopOver review

@loopover-orb loopover-orb Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LoopOver approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 1fb3623 into JSONbored:main Jul 16, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant