Skip to content

docs(ams): port docs/discovery-plane-operator-guide.md to a website docs page (docs.ams-discovery-plane.tsx) - #6391

Merged
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-discovery-plane-6029
Jul 16, 2026
Merged

docs(ams): port docs/discovery-plane-operator-guide.md to a website docs page (docs.ams-discovery-plane.tsx)#6391
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-discovery-plane-6029

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Summary

  • Adds content/docs/ams-discovery-plane.mdx porting packages/loopover-miner/docs/discovery-plane-operator-guide.md to the website: the optional hosted discovery-index plane's opt-in-by-default posture (opposite of Orb's opt-out-only export), the shipped request/response contract vs. the still-provisional opt-in env vars, and the never-included/never-retained data boundaries — rendered via the existing DocsPage/Callout/CodeBlock/FeatureRow ui-kit primitives, following the pattern set in docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6022-docs(ams): port docs/env-reference.md to a generated website docs page (docs.ams-env-reference.tsx) #6028.
  • Adds apps/loopover-ui/src/routes/docs.ams-discovery-plane.tsx, a thin loader + docsClientLoader route matching every other migrated docs page.
  • Adds the page to docs-nav.tsx's "AMS: deployment" subgroup and to docs.index.tsx's Maintainers audience card, and repoints ams-deployment.mdx's and ams-operations-runbook.mdx's GitHub-blob discovery-plane-operator-guide.md cross-references to the new in-app route.
  • packages/loopover-miner/docs/discovery-plane-operator-guide.md stays as the canonical source (ships inside the published @loopover/miner npm package) with a short pointer added to the new website page.
  • The provisional/TBD framing (env var names not yet stable API) is preserved with a warn-variant Callout at the top of the page.

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, rebased on top of the maintainer's CI cache-hit fix (fix(ci): regenerate fumadocs collections unconditionally in validate-code #6375), green: 906 test files / 17,323 tests passed

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 05:59
@superagent-security

Copy link
Copy Markdown
Contributor

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

…ocs page (docs.ams-discovery-plane.tsx)

Add content/docs/ams-discovery-plane.mdx covering the optional hosted
discovery-index plane's opt-in-by-default posture (opposite of Orb's
opt-out-only export), the shipped request/response contract vs. the
still-provisional opt-in env vars, and the never-included/never-retained
data boundaries -- rendered via the existing DocsPage/Callout/CodeBlock/
FeatureRow primitives. Add the page to docs-nav.tsx's "AMS: deployment"
subgroup and to docs.index.tsx's Maintainers audience card, and repoint
ams-deployment.mdx's and ams-operations-runbook.mdx's GitHub-blob
discovery-plane-operator-guide.md cross-references to the new in-app route.

packages/loopover-miner/docs/discovery-plane-operator-guide.md stays as the
canonical source (ships inside the published @loopover/miner package) with a
short pointer added to the new website page.
@oktofeesh1
oktofeesh1 force-pushed the docs/ams-discovery-plane-6029 branch from c62bb7e to 4762efd Compare July 16, 2026 06:04
@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 06:18:05 UTC

8 files · 1 AI reviewer · no blockers · readiness 75/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a docs-porting PR following the established pattern (#6022-#6028): a new MDX content page, a thin TanStack route file, routeTree.gen.ts regeneration, nav wiring in two places, and cross-reference updates in two already-migrated docs pages. The route follows the exact same loader/head/component shape as sibling docs routes, and the cross-reference cleanup correctly repoints GitHub-blob links to the new in-app route while leaving the canonical .md file in place with a pointer back to the website. Closes #6029 as required.

Nits — 6 non-blocking
  • apps/loopover-ui/src/routeTree.gen.ts is machine-generated; verify it was produced by the route generator rather than hand-edited, since the `as any` casts (e.g. routeTree.gen.ts:370) are pre-existing codegen convention, not new risk.
  • apps/loopover-ui/content/docs/ams-discovery-plane.mdx:101 uses 'master opt-in' terminology — consider 'primary opt-in' or similar to match the repo's other docs.
  • No test-path changes accompany this PR, but per the PR's own validation checklist, UI-only docs pages under apps/loopover-ui/** are outside coverage.include, so this is expected for this class of change rather than a gap.
  • Double check that the codegen step (npm run typecheck / route generation) was actually run rather than routeTree.gen.ts being hand-patched, since a manually edited generated file can silently drift from the real route tree.
  • Confirm docs-nav.tsx and docs.index.tsx list orderings are intentional (ams-discovery-plane is appended at the end of the AMS: deployment subgroup, consistent with other recent additions).
  • 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 #6029
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: 66 registered-repo PR(s), 54 merged, 0 issue(s).
Contributor context ✅ Confirmed Gittensor contributor oktofeesh1; Gittensor profile; 66 PR(s), 0 issue(s).
Improvement ℹ️ None detected risk: low · value: none · LLM: minor
Linked issue satisfaction

Not yet addressed
The issue's callout explicitly forbids leaving discovery-plane-operator-guide.md's content unchanged while merely adding a link, and requires deletion or reduction to a one-line pointer stub only after the tsx ships with real content — here the PR keeps the full original markdown content intact and merely inserts a pointer line at the top, which is exactly the disallowed pattern.

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: 66 PR(s), 0 issue(s).
  • Related work: Titles/paths share 6 meaningful terms. (issue #6031)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6030)
  • Related work: Titles/paths share 12 meaningful terms. (issue #6029, 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 3 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://loopover.ai/docs/loopover-commands

🧪 Experimental — new and may change.

Visual preview
Route Viewport Before (production) After (this PR's preview) Diff
/docs/ams-discovery-plane desktop before /docs/ams-discovery-plane
before /docs/ams-discovery-plane
after /docs/ams-discovery-plane
after /docs/ams-discovery-plane
/docs/ams-discovery-plane mobile before /docs/ams-discovery-plane (mobile)
before /docs/ams-discovery-plane (mobile)
after /docs/ams-discovery-plane (mobile)
after /docs/ams-discovery-plane (mobile)
/docs desktop before /docs
before /docs
after /docs
after /docs
/docs mobile before /docs (mobile)
before /docs (mobile)
after /docs (mobile)
after /docs (mobile)

Click any thumbnail to open the full-size screenshot. Before = production · After = this PR's preview deploy.

🟩 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 e56fe3a 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/discovery-plane-operator-guide.md to a website docs page (docs.ams-discovery-plane.tsx)

1 participant