Skip to content

Cross-reference AMS observability from the in-app docs (self-hosting-operations, miner-quickstart, miner-workflow) #5191

Description

@JSONbored

Context

Three in-app documentation routes -- apps/gittensory-ui/src/routes/docs.self-hosting-operations.tsx, docs.miner-quickstart.tsx, and docs.miner-workflow.tsx -- currently have no mention of AMS/the miner alongside Grafana/observability, and no ticketed Wave 4/5/3.5 issue touches these three files. A dual-role self-hoster running both ORB and AMS on one box has no in-app pointer from these docs to the new AMS observability material.

Dependencies

Depends on the 'Observing your miner' doc section landing first (the C38 issue in this same batch) -- this issue's callouts link out to that section, so writing them before it exists would produce dead links. It also assumes the miner-usage.json Grafana dashboard referenced by C37 exists (or is landing in parallel); if that dashboard's path/name changes before this ships, update the callout links accordingly. Do not merge this issue's PR before C38 is merged.

Requirements

  1. Add a short callout (a sentence or two, plus a link) to apps/gittensory-ui/src/routes/docs.self-hosting-operations.tsx pointing a dual-role operator to the AMS observability doc section and the miner-usage.json Grafana dashboard.
  2. Add the equivalent callout to docs.miner-quickstart.tsx.
  3. Add the equivalent callout to docs.miner-workflow.tsx.
  4. All three callouts must be consistent in wording/placement style, and must mirror the existing pattern this codebase already uses when one dashboard doc cross-references another (same phrasing conventions, same link component/pattern).
  5. Ship all three route changes in a single PR for consistency -- do not split this across multiple PRs (per this repo's contributor PR-size norms, three small, related route edits in one PR is expected here).
  6. Do not restructure or rewrite any other content on these three routes -- additive callouts only.

Deliverables / Acceptance Criteria

  • Callout added to docs.self-hosting-operations.tsx
  • Callout added to docs.miner-quickstart.tsx
  • Callout added to docs.miner-workflow.tsx
  • All three callouts link correctly to the AMS observability doc section and the miner-usage.json dashboard
  • Callout wording/placement is consistent across all three routes and matches the existing cross-reference pattern
  • Before/after screenshots of all three routes included in the PR description

Test Coverage Requirements

This PR must ship with full test coverage for every changed line and branch -- the repo's Codecov patch gate requires 99%+ coverage and the house standard is to aim for 100%, including both sides of every conditional/nullish-coalescing branch introduced. Add: (1) unit/component tests covering that each of the three routes renders the new callout (success path) and that the route still renders correctly if the linked dashboard/doc reference is passed through unchanged (no regression to existing content), (2) an invariant test asserting the callout's link target is a well-formed, non-empty URL/path on all three routes (so a copy-paste error in one route can't silently ship a broken or blank link), and (3) no regression test is needed since this is additive content, not a bug fix.

Expected Outcome

A self-hoster running both ORB and AMS can navigate from any of the three existing operational/quickstart/workflow doc pages directly to AMS observability setup and its Grafana dashboard, instead of having to already know that material exists.

Links & Resources

  • apps/gittensory-ui/src/routes/docs.self-hosting-operations.tsx
  • apps/gittensory-ui/src/routes/docs.miner-quickstart.tsx
  • apps/gittensory-ui/src/routes/docs.miner-workflow.tsx
  • See C38 ('Observing your miner' doc section -- hard prerequisite, same batch)
  • See C37 (AMS cross-link panel / miner-usage.json dashboard, same batch)
  • Theme: Dashboard/observability parity

Metadata

Metadata

Assignees

No one assigned

    Labels

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

    Projects

    Status
    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions