Skip to content

docs(ams): decide + possibly port BENCHMARKS.md to a website docs page #6032

Description

@JSONbored

Context

Part of #6012, lowest-confidence item in that epic — deliberately scoped as an evaluation-first issue, not a blind port. packages/loopover-miner/BENCHMARKS.md is a small, committed micro-benchmark for two purely local hot paths (discovery fan-out ranking, local SQLite read/write) with no network dependency, so its numbers are comparable across runs on the same machine. Unlike the other 10 files under #6012, this reads more like a repo-internal contributor artifact (how to run and interpret the benchmark) than an operator-facing guide — but it's genuinely ambiguous, which is why it's last in the sequence: the other 9 sub-issues will have established a real precedent for what "AMS docs on the website" looks like by the time this one is picked up.

⚠️ This issue explicitly does NOT presuppose the answer. Do not port this to a .tsx page as your first step. Decide first, port (or don't) second.

Requirements

  • Step 1 — decide, and state your reasoning in the PR: does BENCHMARKS.md's content belong on the public LoopOver docs website (a page like docs.ams-benchmarks.tsx, if operators/evaluators would genuinely want to see these numbers), or is it correctly a repo-internal contributor artifact that should stay as markdown (if its real audience is someone about to modify the hot paths it covers, checking they haven't regressed)? Look at how the other 9 docs.ams-*.tsx pages from Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012 turned out and whether any of them already surfaces performance/sizing information (the docs.ams-sizing.tsx sub-issue is a related but distinct "capacity" framing, not a "run this benchmark" framing) — don't duplicate.
  • If the decision is "port it": follow the same pattern as the other Epic: port AMS's raw-markdown operator guides to proper website docs pages #6012 sub-issues — apps/loopover-ui/src/routes/docs.ams-benchmarks.tsx, <DocsPage> primitives, delete or stub BENCHMARKS.md, add to docs.index.tsx's nav.
  • If the decision is "keep as markdown": close this issue with a comment explaining why, referencing the reasoning above. That is a legitimate, complete resolution of this issue — it does not need to result in a .tsx file to be done.

Deliverables

  • A stated decision (in the PR or a closing comment) on whether this belongs on the website, with reasoning
  • If ported: apps/loopover-ui/src/routes/docs.ams-benchmarks.tsx added, BENCHMARKS.md deleted/stubbed, linked from docs.index.tsx
  • If not ported: issue closed with reasoning, BENCHMARKS.md left as-is

Test Coverage Requirements

If ported: apps/** UI page, outside coverage.include, no test suite changes required. If not ported: no code changes at all.

Expected Outcome

A deliberate, reasoned decision on this file's placement — not a default port just because the other 10 files in #6012 were ported.

Links & Resources

Metadata

Metadata

Assignees

Labels

gittensor:featureGittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.help wantedExtra attention is neededmaintainer-onlyOwner-only work — yields no Gittensor points.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions