Skip to content

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

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/ams-sizing-6026
Jul 16, 2026
Merged

docs(ams): port docs/sizing.md to a website docs page (docs.ams-sizing.tsx)#6351
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
oktofeesh1:docs/ams-sizing-6026

Conversation

@oktofeesh1

Copy link
Copy Markdown
Contributor

Summary

Scope

  • The PR title follows type(scope): short summary Conventional Commit format.
  • This PR is focused: one new docs page + nav wiring + a cross-reference cleanup in one already-migrated page, under apps/loopover-ui/**, plus a documentation pointer in packages/loopover-miner/docs/sizing.md.
  • This follows CONTRIBUTING.md and does not reintroduce GitHub Pages, VitePress, site/, or CNAME.
  • Closes docs(ams): port docs/sizing.md to a website docs page (docs.ams-sizing.tsx) #6026

Validation

  • git diff --check
  • npm run actionlint
  • npm run typecheck
  • npm run test:coverage locally — UI-only page addition under apps/loopover-ui/** (outside coverage.include); codecov/patch does not apply
  • npm run test:workers
  • npm run build:mcp
  • npm run test:mcp-pack
  • npm run ui:openapi:check
  • npm run ui:lint
  • npm run ui:typecheck
  • npm run ui:build
  • npm audit --audit-level=moderate
  • Full npm run test:ci run locally from a clean npm ci install, green: 900 test files / 17,233 tests passed
  • Caught and fixed a real MDX parse bug during authoring: <owner/repo> in prose spanning a line break inside a backtick code span was parsed as an unterminated JSX tag by fumadocs-mdx's build (npm run ui:build failed with a clear TS-style parse error before the fix); rejoining the sentence onto one line resolved it, confirmed by a clean rebuild

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

…g.tsx)

Add content/docs/ams-sizing.mdx covering measured laptop-mode and fleet-mode
CPU/RAM/disk numbers, the exact reproduction commands, and takeaways --
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 ams-deployment.mdx's operations-runbook.md and sizing.md
cross-references (still GitHub-blob links from before those pages existed)
to the in-app /docs/ams-operations-runbook and /docs/ams-sizing routes, per
the epic's "update any internal cross-references" instruction.

packages/loopover-miner/docs/sizing.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 03:34
@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 03:39:26 UTC

7 files · 1 AI reviewer · no blockers · readiness 82/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This is a straightforward docs-porting PR following the established #6022/#6023/#6024/#6025 pattern: it adds a new route file, generated routeTree entries, nav/index wiring, and the MDX content itself, then repoints stale GitHub-blob cross-references in ams-deployment.mdx to the new in-app routes. The route file mirrors the existing docsClientLoader/DocsPage pattern used elsewhere, results are presented via FeatureRow instead of an unsupported raw table, and the canonical packages/loopover-miner/docs/sizing.md is preserved with a pointer added rather than deleted, avoiding npm package content drift. The PR claims to close #6026 and is scoped tightly to one docs page plus its wiring.

Nits — 5 non-blocking
  • apps/loopover-ui/src/routes/docs.ams-sizing.tsx has no dedicated test coverage, but this matches the existing pattern for prior migrated docs routes (docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6022-docs(ams): port docs/unattended-scheduling.md to a website docs page (docs.ams-unattended-scheduling.tsx) #6025) which also appear untested, so it's consistent rather than a regression.
  • The og:url and canonical href values in docs.ams-sizing.tsx are relative paths ('/docs/ams-sizing') rather than absolute URLs — worth confirming this matches the convention used by sibling docs routes rather than being an oversight.
  • Spot-check that docs-source.ts / the MDX source config actually resolves 'ams-sizing' as a page id matching the new content/docs/ams-sizing.mdx frontmatter slug, since a mismatch would only surface at runtime (notFound()) and isn't visible in this diff.
  • Confirm routeTree.gen.ts is truly generated output (checked into git per this repo's convention) rather than hand-edited, since generated files can drift if the generator command isn't re-run in CI.
  • Code changes lack test evidence — Add focused regression tests or explain why existing coverage is sufficient.

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 #6026
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: 63 registered-repo PR(s), 51 merged, 0 issue(s).
Contributor context ✅ Confirmed Gittensor contributor oktofeesh1; Gittensor profile; 63 PR(s), 0 issue(s).
Improvement ℹ️ None detected risk: low · value: none · LLM: minor
Linked issue satisfaction

Addressed
The PR ports the full sizing.md content (measurement environment, methodology, exact commands, results, takeaways) into content/docs/ams-sizing.mdx rendered through a new apps/loopover-ui/src/routes/docs.ams-sizing.tsx route, adds it to docs-nav.tsx and docs.index.tsx, and reduces sizing.md to essentially its original content plus a pointer stub rather than deleting/gutting it entirely.

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: JavaScript, MDX, Python, TypeScript
  • Official Gittensor activity: 63 PR(s), 0 issue(s).
  • Related work: Titles/paths share 12 meaningful terms. (issue #6031, issue #6027)
  • Related work: Titles/paths share 12 meaningful terms. (issue #6031, issue #6030)
  • Related work: Titles/paths share 12 meaningful terms. (issue #6031, issue #6028)
  • 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 &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @loopover chat &lt;question&gt; 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 1e9f8c3 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/sizing.md to a website docs page (docs.ams-sizing.tsx)

1 participant