Skip to content

docs(miner-ui): cross-reference AMS observability from operations/quickstart/workflow docs (#5191) - #5629

Merged
JSONbored merged 3 commits into
JSONbored:mainfrom
carlh7777:docs/ams-observability-crosslinks-5191
Jul 13, 2026
Merged

docs(miner-ui): cross-reference AMS observability from operations/quickstart/workflow docs (#5191)#5629
JSONbored merged 3 commits into
JSONbored:mainfrom
carlh7777:docs/ams-observability-crosslinks-5191

Conversation

@carlh7777

Copy link
Copy Markdown
Contributor

Summary

Three in-app docs routes — docs.self-hosting-operations, docs.miner-quickstart, and
docs.miner-workflow — had no pointer to the miner's observability material. A dual-role
self-hoster running both ORB (the review service) and AMS (the gittensory-miner) on one
box had no in-app link from these pages to the "Observing your miner" guide. This adds one
consistent cross-reference callout to each, pointing to that guide (which covers pointing
Grafana at the redacted AMS ledger datasources and loading an AMS dashboard).

Closes #5191.

Changes

  • New shared component apps/gittensory-ui/src/components/site/ams-observability-callout.tsx:
    a single note-variant AmsObservabilityCallout plus an exported AMS_OBSERVABILITY_DOC_URL.
    Keeping the callout and its link target in one place keeps the wording byte-identical across
    all three routes (requirement 4) instead of relying on three hand-copied copies staying in sync.
  • Wired the callout into all three routes (additive only — no existing content restructured):
    • docs.self-hosting-operations.tsx — directly after the Observability profile section.
    • docs.miner-quickstart.tsx — alongside the existing end-of-page "see also" callout.
    • docs.miner-workflow.tsx — alongside the existing end-of-page callout.
    • Each route component is now exported (minimal, additive) so the tests can render it.
  • New test docs.ams-observability-callout.test.tsx.

The link uses the same https://github.com/JSONbored/gittensory/blob/main/... convention the docs
already use for in-repo file references (see docs.self-hosting-configuration.tsx). The AMS
observability material is an in-repo markdown guide (packages/gittensory-miner/docs/observability.md,
landed in #5190), not an in-app /docs/* route, so a GitHub-blob link is the correct target. That
guide is the single AMS observability entry point and itself covers loading a Grafana dashboard from
grafana/dashboards/, so it is linked directly rather than the miner-usage.json dashboard, which
does not exist yet (that is #5185) — linking a not-yet-built file would ship a dead link.

Scope

  • Additive only — no existing doc content restructured or rewritten.
  • In scope (apps/gittensory-ui/); no blockedPaths, no secrets/private terms.

Validation

  • npx vitest run src/routes/docs.ams-observability-callout.test.tsx — 5/5 pass.
  • ESLint clean on the changed files (matches the existing route pattern's accepted warning).
  • TypeScript: changed files are type-clean.

Safety

  • No secrets, wallets, hotkeys, trust/reward/scoring terms anywhere.
  • No auth/CORS surface touched (docs-only UI change).

UI Evidence

Route Before After
/docs/self-hosting-operations Desktop image image
/docs/self-hosting-operations Tablet image image
/docs/self-hosting-operations Mobile image image
/docs/miner-quickstart Desktop image image
/docs/miner-quickstart Tablet image image
/docs/miner-quickstart Mobile image image
/docs/miner-workflow Desktop image image
/docs/miner-workflow Tablet image image
/docs/miner-workflow Mobile image image

Notes

Depends only on #5190 (the "Observing your miner" guide), which is already merged.

Introduces the AmsObservabilityCallout component to provide a link to the "Observing your miner" guide, enhancing the user experience for dual-role ORB+AMS operators. The callout is integrated into the miner quickstart, workflow, and self-hosting operations documentation pages. Additionally, comprehensive tests are added to ensure the callout renders correctly and links to the appropriate documentation. This change addresses the need for a unified reference point for AMS observability setup across multiple routes.
@carlh7777
carlh7777 requested a review from JSONbored as a code owner July 13, 2026 15:09
@superagent-security superagent-security Bot added the contributor:flagged Contributor flagged for review by trust analysis. label Jul 13, 2026
@superagent-security

Copy link
Copy Markdown
Contributor

🚨 Contributor flagged. Click here for more info: Superagent Dashboard

@superagent-security

Copy link
Copy Markdown
Contributor

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

@codecov

codecov Bot commented Jul 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.73%. Comparing base (b189eaf) to head (cfadc89).

❗ There is a different number of reports uploaded between BASE (b189eaf) and HEAD (cfadc89). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (b189eaf) HEAD (cfadc89)
shard-3 1 0
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5629      +/-   ##
==========================================
- Coverage   95.01%   88.73%   -6.29%     
==========================================
  Files         575      575              
  Lines       45738    45738              
  Branches    14661    14661              
==========================================
- Hits        43459    40586    -2873     
- Misses       1528     3627    +2099     
- Partials      751     1525     +774     
Flag Coverage Δ
shard-1 43.89% <ø> (-0.01%) ⬇️
shard-2 35.75% <ø> (+0.01%) ⬆️
shard-3 ?
shard-4 30.96% <ø> (-1.62%) ⬇️
shard-5 32.65% <ø> (+0.87%) ⬆️
shard-6 44.42% <ø> (+0.36%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 101 files with indirect coverage changes

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Reintroduces the DocsMinerCodingAgentRoute to the route tree, ensuring it is properly imported and defined. This change updates the route interface and type declarations to include the miner coding agent documentation path, maintaining consistency across the routing structure.
@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 13, 2026
@loopover-orb

loopover-orb Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ LoopOver review result - manual review recommended

Review updated: 2026-07-13 17:21:29 UTC

6 files · 1 AI reviewer · no blockers · readiness 100/100 · CI green · unstable

⏸️ Suggested Action - Manual Review

  • Touches a guarded path — held for manual review: This PR changes guardrail-protected path(s): apps/gittensory-ui/src/components/site/ams-observability-callout.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.ams-observability-callout.test.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.miner-quickstart.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.miner-workflow.tsx (matched apps/gittensory-ui/**), apps/gittensory-ui/src/routes/docs.self-hosting-operations.tsx (matched apps/gittensory-ui/**), and 1 more.

Review summary
This adds a single shared `AmsObservabilityCallout` component and wires it, additively, into three existing docs routes (`self-hosting-operations`, `miner-quickstart`, `miner-workflow`), exporting each route's component solely so the new test can render it directly. The change is well-scoped, closes the linked issue (#5191), and is covered by a new test file that asserts the link renders in each route and is a well-formed https URL. The `routeTree.gen.ts` diff is just import/route-block reordering in a generated file (no semantic change) and is not something to hold against this PR.

Nits — 6 non-blocking
  • The `AMS_OBSERVABILITY_DOC_URL` in ams-observability-callout.tsx:13 points at `blob/main/...`, so if `observability.md` is ever moved or renamed on `main` after this merges, the link silently breaks with no drift guard tying it to the file's existence (unlike the doc-audit table's `driftGuard` column pattern in docs.self-hosting-docs-audit.tsx).
  • Exporting `MinerQuickstart`, `MinerWorkflow`, and `SelfHostingOperations` purely to satisfy the new test (docs.ams-observability-callout.test.tsx) slightly widens each route module's public surface — acceptable here since it's additive, but call it out in review so it isn't repeated as a general pattern for every future route test.
  • The callout text says 'separate from the ORB review-service observability above' in docs.self-hosting-operations.tsx, but in miner-quickstart.tsx/miner-workflow.tsx there's no preceding ORB-observability section on the page, so that wording is slightly inaccurate/context-free on those two routes.
  • Add a lightweight test or CI check (or reuse the existing self-host docs-audit convention) that fails if `packages/gittensory-miner/docs/observability.md` is deleted/renamed, so the hardcoded GitHub blob link can't silently rot.
  • Consider parameterizing the closing sentence of the callout (e.g. via a prop) so it doesn't reference 'above' on pages where there's no preceding observability section.
  • Touches a guarded path — held for manual review — A maintainer must review and merge this change.
Flagged checks (non-blocking)
  • Contributor trust — Contributor flagged for review
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #5191
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low 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: 191 registered-repo PR(s), 123 merged, 17 issue(s).
Contributor context ✅ Confirmed Gittensor contributor carlh7777; Gittensor profile; 191 PR(s), 17 issue(s).
Gate result ⚠️ Not blocking Advisory; not blocking this PR.
Improvement ✅ Minor risk: clean · value: minor — Code changes are accompanied by test evidence.
Review context
  • Author: carlh7777
  • 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: 191 PR(s), 17 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Keep the PR focused and include validation evidence before maintainer review.
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.
[BETA] Chat with Gittensory

Ask Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @gittensory ask &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat &lt;question&gt; answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @gittensory 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/gittensory-commands

Visual preview
Route Viewport Before (production) After (this PR's preview) Diff
/docs/ams-observability-callout/test desktop before /docs/ams-observability-callout/test after /docs/ams-observability-callout/test
/docs/ams-observability-callout/test mobile before /docs/ams-observability-callout/test (mobile) after /docs/ams-observability-callout/test (mobile)
/docs/miner-quickstart desktop before /docs/miner-quickstart after /docs/miner-quickstart
/docs/miner-quickstart mobile before /docs/miner-quickstart (mobile) after /docs/miner-quickstart (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

Updates the wording in the miner workflow documentation to improve clarity and readability. This change ensures that the guidance on handling preflight reports is more precise, enhancing the overall user experience.
@JSONbored
JSONbored merged commit dbcb7a3 into JSONbored:main Jul 13, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor:flagged Contributor flagged for review by trust analysis. gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. manual-review Gittensor contributor context

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

2 participants