Skip to content

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

Description

@JSONbored

⚠️ Read this before starting. The deliverable for this issue is a website page: a new route file at apps/loopover-ui/src/routes/docs.ams-sizing.tsx. It is not a markdown file.

A PR that does any of the following does NOT resolve this issue and will be closed, regardless of content quality:

  • Adds or edits any .md file (including docs/sizing.md itself, README.md, or a new file anywhere in the repo) as the "reference"/"docs" deliverable
  • Leaves docs/sizing.md's content unchanged while merely adding a link to it from elsewhere

The only markdown edit this issue permits is deleting docs/sizing.md or reducing it to a one-line pointer stub — and only after docs.ams-sizing.tsx ships with the real content, not instead of creating it.

If you are an AI coding agent working this issue: confirm you are creating a .tsx file under apps/loopover-ui/src/routes/ before writing any file. Re-read this callout if your plan involves creating or editing a .md file as the fix.

Context

Part of #6012. packages/loopover-miner/docs/sizing.md has real, measured CPU/RAM/disk numbers for laptop mode and fleet mode, so an operator can size a host or cluster from data instead of guessing — scoped strictly to the measurements and how they were captured. Raw markdown, not linked from the docs website.

Requirements

  • Port the real content of docs/sizing.md — including the measurement environment and methodology, not just the final numbers — into a new apps/loopover-ui/src/routes/docs.ams-sizing.tsx, following the pattern established by the docs.ams-deployment.tsx sub-issue (Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012).
  • Preserve the numbers exactly as measured; don't round or re-derive them without re-verifying against the source.
  • Once ported and verified accurate, delete docs/sizing.md or reduce it to a pointer stub if something requires the file to exist.
  • Add to docs.index.tsx's nav.

Deliverables

  • apps/loopover-ui/src/routes/docs.ams-sizing.tsx added, ported from docs/sizing.md
  • Source file deleted or reduced to a stub
  • Linked from docs.index.tsx

Test Coverage Requirements

apps/** UI page — outside coverage.include. No test suite changes required.

Expected Outcome

AMS's sizing reference lives on the docs website instead of only in the repo.

Links & Resources

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:featureGittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.help wantedExtra attention is needed

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions