Skip to content

docs(ams): port DEPLOYMENT.md to a website docs page (docs.ams-deployment.tsx) #6022

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-deployment.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 DEPLOYMENT.md itself, README.md, or a new file anywhere in the repo) as the "guide"/"docs" deliverable
  • Leaves DEPLOYMENT.md's content unchanged while merely adding a link to it from elsewhere

The only markdown edit this issue permits is deleting DEPLOYMENT.md or reducing it to a one-line pointer stub — and only after docs.ams-deployment.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/DEPLOYMENT.md is AMS's deployment guide — laptop mode (zero Docker, single machine) vs. fleet mode (containerized workers, shared data volume), both 100% client-side, credentials never baked into images. It's the AMS-side counterpart to ORB's docs.self-hosting-quickstart.tsx, but sits as raw markdown instead of a website page, and isn't linked from the docs site at all.

Requirements

  • Port DEPLOYMENT.md's real content (read the current file directly — don't work from this issue's summary) into a new apps/loopover-ui/src/routes/docs.ams-deployment.tsx page, following docs.self-hosting-quickstart.tsx's exact structure: createFileRoute, head() meta/OG tags, <DocsPage> using the shared Callout/CodeBlock/FeatureRow primitives from @/components/site/primitives.
  • Preserve the laptop-mode-vs-fleet-mode comparison table and all real commands/paths — this is the page a first-time AMS operator lands on, accuracy matters more than brevity.
  • Grep the repo for other files that link to DEPLOYMENT.md (at minimum packages/loopover-miner/docs/operations-runbook.md references it as ../DEPLOYMENT.md) and update those links to the new /docs/ams-deployment URL.
  • Once ported and verified accurate, delete packages/loopover-miner/DEPLOYMENT.md (it's not referenced by package.json files in a way that requires it to exist at publish time — verify this before deleting, and if it is required, replace its contents with a one-line pointer to the website URL instead of deleting).
  • Add the new page to docs.index.tsx's "Maintainers" audience links, establishing the nav placement the other AMS-docs sub-issues (Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012) will follow.

Deliverables

  • apps/loopover-ui/src/routes/docs.ams-deployment.tsx added, ported from DEPLOYMENT.md
  • Cross-references to DEPLOYMENT.md updated repo-wide
  • DEPLOYMENT.md deleted or reduced to a pointer stub (confirm which, based on package.json files requirements)
  • Linked from docs.index.tsx's "Maintainers" audience

Test Coverage Requirements

apps/** UI page — outside coverage.include, so Codecov's patch gate does not apply. No test suite changes required.

Expected Outcome

An AMS operator finds the deployment guide on the LoopOver docs website, structurally parallel to ORB's self-hosting-quickstart page.

Links & Resources

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