Skip to content

docs(ams): port docs/miner-goal-spec.md to a website docs page (docs.ams-goal-spec.tsx) #6030

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

The only markdown edit this issue permits is deleting docs/miner-goal-spec.md or reducing it to a one-line pointer stub — and only after docs.ams-goal-spec.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/miner-goal-spec.md is the field reference for .loopover-miner.yml — per-repo configuration telling an autonomous miner what to look for and how to behave, parsed by parseMinerGoalSpec/parseMinerGoalSpecContent in @loopover/engine. It's the closest AMS-side analog to ORB's .loopover.yml config docs (docs.self-hosting-configuration.tsx) but sits as raw markdown, unlinked from the website. A machine-readable JSON Schema (../schema/miner-goal-spec.schema.json) backs it and should stay in place — only the human-readable field reference moves.

Requirements

  • Port the real content of docs/miner-goal-spec.md into a new apps/loopover-ui/src/routes/docs.ams-goal-spec.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).
  • Keep the discovery-order list (.loopover-miner.yml, .github/loopover-miner.yml, etc.) and the link to .loopover-miner.yml.example accurate — verify both against the current repo before porting.
  • ../schema/miner-goal-spec.schema.json (the JSON Schema file) is not in scope for this issue — it stays as-is; only the prose field-reference markdown moves.
  • Once ported and verified accurate, delete docs/miner-goal-spec.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-goal-spec.tsx added, ported from docs/miner-goal-spec.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 .loopover-miner.yml field reference lives on the docs website instead of only in the repo.

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