docs(miner-ui): cross-reference AMS observability from operations/quickstart/workflow docs (#5191) - #5629
Conversation
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.
|
🚨 Contributor flagged. Click here for more info: Superagent Dashboard |
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests.
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
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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.
|
Warning 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨 ⏸️ LoopOver review result - manual review recommendedReview updated: 2026-07-13 17:21:29 UTC
⏸️ Suggested Action - Manual Review
Review summary Nits — 6 non-blocking
Flagged checks (non-blocking)
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk 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.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands Visual previewClick 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.
|
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.








Summary
Three in-app docs routes —
docs.self-hosting-operations,docs.miner-quickstart, anddocs.miner-workflow— had no pointer to the miner's observability material. A dual-roleself-hoster running both ORB (the review service) and AMS (the
gittensory-miner) on onebox 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
apps/gittensory-ui/src/components/site/ams-observability-callout.tsx:a single
note-variantAmsObservabilityCalloutplus an exportedAMS_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.
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.exported (minimal, additive) so the tests can render it.docs.ams-observability-callout.test.tsx.The link uses the same
https://github.com/JSONbored/gittensory/blob/main/...convention the docsalready use for in-repo file references (see
docs.self-hosting-configuration.tsx). The AMSobservability 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. Thatguide is the single AMS observability entry point and itself covers loading a Grafana dashboard from
grafana/dashboards/, so it is linked directly rather than theminer-usage.jsondashboard, whichdoes not exist yet (that is #5185) — linking a not-yet-built file would ship a dead link.
Scope
apps/gittensory-ui/); noblockedPaths, no secrets/private terms.Validation
npx vitest run src/routes/docs.ams-observability-callout.test.tsx— 5/5 pass.Safety
UI Evidence
/docs/self-hosting-operationsDesktop/docs/self-hosting-operationsTablet/docs/self-hosting-operationsMobile/docs/miner-quickstartDesktop/docs/miner-quickstartTablet/docs/miner-quickstartMobile/docs/miner-workflowDesktop/docs/miner-workflowTablet/docs/miner-workflowMobileNotes
Depends only on #5190 (the "Observing your miner" guide), which is already merged.