Skip to content

docs(ams): port docs/observability.md to a website docs page (docs.ams-observability.tsx) #6024

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

The only markdown edit this issue permits is deleting docs/observability.md or reducing it to a one-line pointer stub — and only after docs.ams-observability.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/observability.md explains how to point Grafana at redacted miner reporting exports to see attempt and prediction history without exposing the miner's live local ledgers — scoped to miner-specific observability wiring only (points to a general self-host ops runbook for everything else). Raw markdown, not linked from the docs website.

Requirements

  • Port the real content of docs/observability.md into a new apps/loopover-ui/src/routes/docs.ams-observability.tsx, following the pattern established by the docs.ams-deployment.tsx sub-issue (Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012) — reuse its nav placement decision.
  • Once ported and verified accurate, delete docs/observability.md or reduce it to a pointer stub if something requires the file to exist.
  • Add to docs.index.tsx's nav.

Deliverables

  • apps/loopover-ui/src/routes/docs.ams-observability.tsx added, ported from docs/observability.md
  • 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 observability setup guide 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