Skip to content

docs(miner): point the discovery-plane operator guide at the now-shipped discovery-index contract - #5978

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
lourincedaging0-commits:docs-discovery-guide-contract
Jul 15, 2026
Merged

docs(miner): point the discovery-plane operator guide at the now-shipped discovery-index contract#5978
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
lourincedaging0-commits:docs-discovery-guide-contract

Conversation

@lourincedaging0-commits

Copy link
Copy Markdown
Contributor

Closes #5938. Docs-only (one .md file, no code touched).

packages/loopover-miner/docs/discovery-plane-operator-guide.md's placeholder-scope callout said the contract/telemetry/client symbols were provisional until the sibling issues land — but #4300/#4301/#4302 have all shipped as real, tested modules.

No src/** touched → outside coverage.include; the test shards skip.

…ped discovery-index contract

JSONbored#4300/JSONbored#4301/JSONbored#4302 have landed as real, tested modules, so the guide's placeholder-scope callout no longer
matches reality. Marks the request/response contract (DiscoveryIndexQuery/Response/Candidate, stable at
DISCOVERY_INDEX_CONTRACT_VERSION 1), the telemetry event schema, and the client soft-claim builder as shipped,
cross-referencing discovery-index-contract.ts/.md, miner-telemetry.ts, and discovery-soft-claim.ts. Preserves
the still-true caveat that the operator-facing opt-in env vars (LOOPOVER_MINER_DISCOVERY_* — verified still
absent from packages/loopover-miner/lib/) remain TBD pending the hosted server + opt-in wiring (JSONbored#4250). Docs
only; no code touched.

Closes JSONbored#5938
@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:bug Gittensor-scored bug fix — scores a 0.05x multiplier. label Jul 15, 2026
@loopover-orb

loopover-orb Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-15 05:35:02 UTC

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

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
Docs-only update to discovery-plane-operator-guide.md that reclassifies the contract/telemetry/soft-claim symbols from #4300/#4301/#4302 as shipped, linking to the actual source files, while correctly preserving the caveat that the operator-facing env vars/opt-in wiring (#4250) remain unimplemented. The change is internally consistent — the scope table, the opt-in section heading, and the surrounding prose all agree on what's shipped vs. still TBD — and closes the linked issue #5938 with a narrowly-scoped, single-file edit.

Nits — 3 non-blocking
  • The PR asserts the linked source files (discovery-index-contract.ts, miner-telemetry.ts, discovery-soft-claim.ts) exist and match the described symbol names, which can't be verified from this diff alone — worth a quick confirm before merge.
  • Table row for feat(discovery-plane): stand up the hosted discovery-index server #4250 conflates 'hosted discovery-index server' and 'operator-facing opt-in wiring' as one item; splitting them could avoid future ambiguity about which sub-piece is blocking.
  • Consider adding a one-line note on where DISCOVERY_INDEX_CONTRACT_VERSION is defined/exported so operators can quickly check version compatibility once opt-in ships.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #5938
Related work ⚠️ 2 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), 26 merged, 4 issue(s).
Contributor context ✅ Confirmed Gittensor contributor lourincedaging0-commits; Gittensor profile; 63 PR(s), 4 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ℹ️ Insufficient signal risk: clean · value: insufficient-signal · LLM: minor
Linked issue satisfaction

Addressed
The diff updates the placeholder-scope table to mark #4300/#4301/#4302 as shipped with direct links to discovery-index-contract.ts/.md, miner-telemetry.ts, and discovery-soft-claim.ts, while explicitly preserving the 'TBD' caveat for the opt-in env vars and framing #4250 as the actual blocker, matching all stated requirements. The PR description also references grep verification of both the shippe

Review context
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 <question> answers contribution-quality Q&A with source citations and freshness.
  • @loopover chat <question> 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 ce126e6 into JSONbored:main Jul 15, 2026
9 checks passed
@nghetienhiep nghetienhiep mentioned this pull request Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:bug Gittensor-scored bug fix — scores a 0.05x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(miner): discovery-plane-operator-guide.md doesn't reference the now-shipped discovery-index contract

1 participant