Skip to content

docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) - #6312

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/ams-deployment-6022
Jul 16, 2026
Merged

docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx)#6312
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/ams-deployment-6022

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Summary

  • Adds content/docs/ams-deployment.mdx porting packages/loopover-miner/DEPLOYMENT.md's operator guide (laptop mode, fleet mode, Docker Compose, systemd, secret-file handling) to the website, rendered via the existing DocsPage/Callout/CodeBlock/FeatureRow ui-kit primitives — following docs.self-hosting-quickstart.tsx's current fumadocs-mdx pattern.
  • Adds apps/loopover-ui/src/routes/docs.ams-deployment.tsx, a thin loader + docsClientLoader route matching every other migrated docs page.
  • Adds the page to the docs nav: a new "AMS: deployment" subgroup under docs-nav.tsx's Maintainers group (the navigation precedent the epic asked the first landing sub-issue to set), plus the Maintainers audience card on docs.index.tsx.
  • The overlapping "bridge AMS state for ORB observability" section is not duplicated — it links to the already-migrated /docs/self-hosting-unified-ams-orb page instead.
  • packages/loopover-miner/DEPLOYMENT.md stays in place as the canonical source: it ships inside the published @loopover/miner npm package (check-miner-package.test.ts requires it) and its content is directly asserted by miner-deployment-doc.test.ts, miner-deployment-docs-audit.test.ts, miner-operations-runbook.test.ts, and ams-observability-compose-parity.test.ts. A short pointer to the new website page was added at the top; selfhost-docs-audit.ts's LOOSE_DOCS_ROWS entry now notes the website counterpart.

This is a resubmission of #6280, which was auto-closed on a repo-wide CI bug (fumadocs-mdx's collections/* virtual modules never generated on a fresh checkout) unrelated to this page's content — now fixed by PR #6310 (merged), which this branch is rebased on top of.

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
  • Reproduced docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6280's exact CI failure locally with a truly clean checkout (rm -rf apps/loopover-ui/.source && npm ci) before the fix, confirmed the fix resolves it, and confirmed real CI on fix(ui): generate fumadocs-mdx collections/* via postinstall #6310 passed validate/validate-code
  • Targeted re-run of every test touching DEPLOYMENT.md/the audit manifest: miner-deployment-doc, miner-deployment-docs-audit, docs-selfhost-audit-checklist, ams-observability-compose-parity, miner-operations-runbook, miner-ui-systemd-launcher, check-miner-package — all 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

…ment.tsx)

Add content/docs/ams-deployment.mdx (fumadocs-mdx pipeline) covering laptop
mode, fleet mode, Docker Compose, systemd, and the ORB observability bridge,
rendered via the existing DocsPage/Callout/CodeBlock/FeatureRow primitives.
Add the page to docs-nav.tsx's Maintainers group (new "AMS: deployment"
subgroup, the precedent for the epic's remaining sub-issues) and to
docs.index.tsx's Maintainers audience card.

packages/loopover-miner/DEPLOYMENT.md stays as the canonical source (it ships
inside the published @loopover/miner package and is asserted by
miner-deployment-doc.test.ts and check-miner-package.test.ts) with a short
pointer added to the new website page; selfhost-docs-audit.ts's LOOSE_DOCS_ROWS
entry now notes the website counterpart.
@oktofeesh1
oktofeesh1 requested a review from JSONbored as a code owner July 16, 2026 01:08
@superagent-security

Copy link
Copy Markdown
Contributor

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

@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:17:47 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This adds a single new docs route (docs.ams-deployment.tsx) plus its content/docs mdx page, wires it into docs-nav.tsx and docs.index.tsx, and updates the generated routeTree.gen.ts and selfhost-docs-audit.ts pointer entry — following the exact pattern of the existing docs.self-hosting-quickstart.tsx route. The route/loader/head wiring is structurally consistent with sibling docs routes (path lookup via docsSource.getPage, Suspense + docsClientLoader.getComponent), and the DEPLOYMENT.md source file is left in place with a forward pointer, matching the stated intent of not duplicating canonical content. The most notable detail is the new `notes` field added to a `LOOSE_DOCS_ROWS` entry in selfhost-docs-audit.ts, which is only safe if the `LooseDocsRow` type (not shown in this diff) already declares that field.

Nits — 6 non-blocking
  • apps/loopover-ui/src/lib/selfhost-docs-audit.ts:234 adds a `notes` field to a `LOOSE_DOCS_ROWS` entry — confirm the `LooseDocsRow` type already includes `notes`, otherwise this is a TS compile error not visible in this diff.
  • No dedicated test coverage is added for docs.ams-deployment.tsx, docs-nav.tsx, or docs.index.tsx changes, though this appears consistent with how other docs.*.tsx route pages in this repo are handled.
  • The PR description doesn't cite a concrete tracking issue number this closes, only referencing 'the epic' and a sub-issue precedent — worth confirming there's an eligible linked issue per repo convention.
  • Double check `LooseDocsRow`'s type definition (likely in selfhost-docs-audit.ts above the diff) includes an optional `notes?: string` field.
  • Since this is a resubmission of docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6280, confirm the rebase onto fix(ui): generate fumadocs-mdx collections/* via postinstall #6310's fumadocs-mdx fix actually resolves the earlier CI failure for this exact content.
  • 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 #6022
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: minor
Linked issue satisfaction

Not yet addressed
The issue's callout explicitly forbids adding an .md file as the docs deliverable and requires DEPLOYMENT.md to be deleted or reduced to a one-line pointer stub, yet this PR adds content/docs/ams-deployment.mdx (a markdown file carrying the real content) while leaving DEPLOYMENT.md's substantive content in place with only a pointer added at the top, not reduced to a stub.

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: not available
  • 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 #6023)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6031)
  • 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 db98770 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 DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx)

1 participant