Skip to content

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

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-discovery-plane.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/discovery-plane-operator-guide.md itself, README.md, or a new file anywhere in the repo) as the "operator guide"/"docs" deliverable
  • Leaves docs/discovery-plane-operator-guide.md's content unchanged while merely adding a link to it from elsewhere

The only markdown edit this issue permits is deleting docs/discovery-plane-operator-guide.md or reducing it to a one-line pointer stub — and only after docs.ams-discovery-plane.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/discovery-plane-operator-guide.md is the operator-facing guide for the optional hosted discovery-index plane — how a loopover-miner instance opts in, what it may send, and what never leaves the operator's machine. The contract/telemetry/client-builder pieces have shipped (per the doc's own scope callout); the operator-facing opt-in wiring (env var names, HTTP paths) remains provisional pending the hosted server. Raw markdown, not linked from the docs website.

Requirements

Deliverables

  • apps/loopover-ui/src/routes/docs.ams-discovery-plane.tsx added, ported and verified against current shipped/provisional status
  • 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 discovery-plane operator guide lives on the docs website instead of only in the repo, with accurate shipped-vs-provisional framing.

Links & Resources

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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