Skip to content

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

Merged
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-observability-6024
Jul 16, 2026
Merged

docs(ams): port docs/observability.md to a website docs page (docs.ams-observability.tsx)#6331
loopover-orb[bot] merged 2 commits into
JSONbored:mainfrom
oktofeesh1:docs/ams-observability-6024

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Summary

  • Adds content/docs/ams-observability.mdx porting packages/loopover-miner/docs/observability.md to the website: pointing Grafana at the redacted AMS attempt-log/prediction-ledger reporting exports, loading a dashboard, opt-in Prometheus textfile metrics, and the opt-in anonymized central telemetry export — rendered via the existing DocsPage/Callout/CodeBlock/FeatureRow ui-kit primitives, following the pattern set in docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6022/docs(ams): port docs/operations-runbook.md to a website docs page (docs.ams-operations-runbook.tsx) #6023.
  • Adds apps/loopover-ui/src/routes/docs.ams-observability.tsx, a thin loader + docsClientLoader route matching every other migrated docs page.
  • Adds the page to docs-nav.tsx's "AMS: deployment" subgroup (alongside the deployment guide and operations runbook) and to docs.index.tsx's Maintainers audience card.
  • Repoints the shared AmsObservabilityCallout component (embedded in self-hosting-operations, miner-quickstart, and miner-workflow) from a GitHub-blob link at the raw markdown to an in-app Link at the new website page, per the epic's "update any internal cross-references" instruction. Its test mocks Link the same way site-header.test.tsx already does.
  • packages/loopover-miner/docs/observability.md stays as the canonical source: it ships inside the published @loopover/miner npm package and its content is directly referenced by other tests. A short pointer to the new website page was added at the top.

Scope

Validation

Safety

  • No secrets, wallet details, hotkeys, coldkeys, user PATs, private keys, raw trust scores, private rankings, or private maintainer evidence are exposed.
  • Public GitHub text stays sanitized, low-noise, and does not imply compensation guarantees or optimization tactics.
  • Auth, cookie, CORS, GitHub App, Cloudflare, or session changes include negative-path tests. — N/A, no such changes in this PR
  • API/OpenAPI/MCP behavior is updated and tested where needed. — N/A, no API/OpenAPI/MCP behavior changed
  • UI changes use live API data or real empty/error/loading states, not production mock/demo fallbacks. — N/A, static docs content only
  • Public docs/changelogs are updated where needed; changelogs are only edited for release-prep PRs.

Notes

…s-observability.tsx)

Add content/docs/ams-observability.mdx covering the AMS Grafana datasources
(attempt-log + prediction-ledger reporting exports), dashboard loading,
opt-in Prometheus textfile metrics, and the opt-in anonymized central
telemetry export -- rendered via the existing DocsPage/Callout/CodeBlock/
FeatureRow primitives. Add the page to docs-nav.tsx's "AMS: deployment"
subgroup and to docs.index.tsx's Maintainers audience card.

Repoint the shared AmsObservabilityCallout component (embedded in
self-hosting-operations, miner-quickstart, and miner-workflow) from a
GitHub-blob link at the raw markdown to an in-app Link at the new website
page, per the epic's "update any internal cross-references" instruction --
mock Link in its test the same way site-header.test.tsx already does.

packages/loopover-miner/docs/observability.md stays as the canonical source
(ships inside the published @loopover/miner package) with a short pointer
added to the new website page.
@oktofeesh1
oktofeesh1 requested a review from JSONbored as a code owner July 16, 2026 02:13
@superagent-security

Copy link
Copy Markdown
Contributor

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

@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 16, 2026
@loopover-orb

loopover-orb Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Tip

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-16 02:18:59 UTC

8 files · 1 AI reviewer · no blockers · readiness 80/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This PR ports the miner's observability.md into an in-app docs route (ams-observability.tsx + content/docs/ams-observability.mdx), wires it into docs-nav and docs.index, and repoints the shared AmsObservabilityCallout from a raw GitHub blob link to an in-app Link — following the exact pattern used by #6022/#6023 and closing #6024. The route/loader shape, routeTree.gen.ts regeneration, and nav/index entries are all consistent with existing sibling docs pages, and the callout test correctly swaps its href assertion and adds a Link mock matching the site-header.test.tsx convention. The canonical markdown source is preserved in packages/loopover-miner/docs/observability.md with just a pointer comment added, which is the right layer to keep publishing inside the npm package.

Nits — 5 non-blocking
  • apps/loopover-ui/src/components/site/ams-observability-callout.tsx: the comment block is fairly long for a one-line URL change — could be trimmed now that the GitHub-blob rationale no longer applies.
  • apps/loopover-ui/src/components/site/docs-nav.tsx:80: 'Observing your miner' is appended after 'Operations runbook' rather than alphabetized with the other two entries — fine if intentional grouping, but worth a one-line note if there's a rationale.
  • apps/loopover-ui/src/routes/docs.ams-observability.tsx: verify Callout variant 'safety' used in the mdx (content/docs/ams-observability.mdx) is a recognized variant in the Callout primitive, since it's not one of the variants shown elsewhere in this diff (note/warn).
  • Double check apps/loopover-ui/content/docs/ams-observability.mdx renders correctly end-to-end via docsClientLoader in a local dev run, since MDX content changes aren't type-checked the same way TSX is.
  • Confirm the new https:​//loopover.ai/docs/ams-observability pointer added to packages/loopover-miner/docs/observability.md matches the site's actual deployed domain before merge.

Decision drivers

  • ✅ Code review — No blockers (1 reviewer)
  • ✅ Gate result — Passing (No configured blocker found.)
Context & advisory signals — never blocks the verdict
Signal Result Evidence
Linked issue ✅ Linked #6024
Related work ⚠️ 3 scoped overlaps Top overlaps are listed below; lower-confidence bulk is hidden.
Change scope ❌ 8/20 High 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: 58 registered-repo PR(s), 47 merged, 1 issue(s).
Contributor context ✅ Confirmed Gittensor contributor oktofeesh1; Gittensor profile; 58 PR(s), 1 issue(s).
Improvement ✅ Minor risk: clean · value: minor · LLM: moderate
Linked issue satisfaction

Addressed
The PR creates apps/loopover-ui/src/routes/docs.ams-observability.tsx backed by a real MDX content file with the full ported observability.md content, wires it into docs-nav.tsx and docs.index.tsx, and updates the internal cross-reference in ams-observability-callout.tsx to an in-app Link as instructed. The one deviation from the issue's strict instructions is that docs/observability.md is kept as

Review context
  • Author: oktofeesh1
  • 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: 58 PR(s), 1 issue(s).
  • Related work: Titles/paths share 6 meaningful terms. (issue #6025)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6031)
  • Related work: Titles/paths share 6 meaningful terms. (issue #6027)
  • Additional title-only matches omitted; title-only overlap does not block.
Contributor next steps
  • Start here: Review top overlaps.
  • Then work through the remaining 2 steps in the Signals table above.
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.
🧪 Chat with LoopOver

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

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

🧪 Experimental — new and may change.

🟩 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

@loopover-orb loopover-orb Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LoopOver approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 0955c3c into JSONbored:main Jul 16, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

1 participant