docs(miner-discovery): author MinerGoalSpec schema doc (#2300)

[kiannidev]

Summary

• Add packages/gittensory-miner/docs/miner-goal-spec.md — field-by-field reference for .gittensory-miner.yml
• Add packages/gittensory-miner/schema/miner-goal-spec.schema.json (JSON Schema draft 2020-12) matching the shipped MinerGoalSpec parser
• Document the relationship to .gittensory.yml and link from the miner package README
• Regression test asserts the root .gittensory-miner.yml.example round-trips through parseMinerGoalSpecContent

Closes #2300

Test plan

• npx vitest run test/unit/miner-goal-spec-doc.test.ts --coverage
• npm run build --workspace @jsonbored/gittensory-engine && npm run build:miner

Made with Cursor

[superagent-security]

Superagent didn't find any vulnerabilities or security issues in this PR.

[loopover-orb]

Warning

🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨

⏸️ Gittensory review result - manual review recommended

_{Review updated: 2026-07-05 19:28:50 UTC}

4 files · 1 AI reviewer · no blockers · readiness 80/100 · CI green · clean

⏸️ Suggested Action - Manual Review

Review summary
This is a pure documentation/schema addition: a JSON Schema draft 2020-12 file for MinerGoalSpec, a field-by-field markdown reference, a README link, and a regression test that round-trips the root .gittensory-miner.yml.example through the real parseMinerGoalSpecContent parser. The test asserts on parsed output (not just presence of text), which meaningfully ties the doc/schema to the actual shipped parser behavior rather than being decorative. No src/** files are touched, so patch-coverage requirements don't apply, and CI (including codecov and build) already passed on this commit.

Nits — 5 non-blocking

• The JSON schema's `maxConcurrentClaims` has `minimum: 1` but no upper bound or explicit `required`/`type` coercion notes — fine given every field is optional, but worth a comment noting the parser's own validation is authoritative if it diverges from the schema over time.
• packages/gittensory-miner/docs/miner-goal-spec.md documents a 4-path discovery order (`.gittensory-miner.yml`, `.github/gittensory-miner.yml`, `.gittensory-miner.json`, `.github/gittensory-miner.json`) that isn't verified anywhere in this diff/test — consider adding a small test asserting the parser's actual lookup order matches the doc, since docs drifting from parser behavior is the main failure mode for a reference doc like this.
• The schema `$id` points to `https:​//jsonbored.dev/schemas/gittensory-miner-goal-spec.json`, an external URL not verified reachable in this diff — if that URL isn't actually hosted yet, tools resolving `$id` could fail; worth confirming it resolves or noting it's aspirational.
• Add a test (or note in the doc) confirming the four-path discovery order actually matches `parseMinerGoalSpec`'s file-lookup implementation, since that's the one claim in the doc not exercised by the new regression test.
• Consider validating the schema itself with an ajv compile step in the test (beyond just checking `properties` keys) to catch schema syntax regressions on future edits.

Signal	Result	Evidence
Code review	✅ No blockers	1 reviewer
Linked issue	✅ Linked	#2300
Related work	✅ No active overlap found	No same-issue or scoped active PR overlap found.
Change scope	✅ 20/20	Low review scope from cached public metadata (1 linked issue).
Validation posture	❌ 5/25	Preflight is holding this PR: the review lane is unavailable, so it is not ready for automated review.
Contributor workload	✅ 10/10	Author activity: 1458 registered-repo PR(s), 751 merged, 48 issue(s).
Contributor context	✅ Confirmed Gittensor contributor	kiannidev; Gittensor profile; 1458 PR(s), 48 issue(s).
Gate result	✅ Passing	No configured blocker found.

Review context

• Author: kiannidev
• Role context: outside_contributor
• Public audience mode: oss maintainer
• Lane context: Repository registration is not available in the local Gittensory cache.
• Public profile languages: TypeScript, MDX, C++, HTML, Rust
• Official Gittensor activity: 1458 PR(s), 48 issue(s).
• PR-specific overlap: none found.

Contributor next steps

• Await review-lane availability.
• Refresh registry data or choose a registered active repo.

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.

_{🟩 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 Gittensory, a quiet PR intelligence layer for OSS maintainers.

• Re-run Gittensory review

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.19%. Comparing base (bfa9c2d) to head (03b1475).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3618   +/-   ##
=======================================
  Coverage   93.19%   93.19%           
=======================================
  Files         313      313           
  Lines       31874    31874           
  Branches    11666    11666           
=======================================
  Hits        29705    29705           
  Misses       1517     1517           
  Partials      652      652           

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[loopover-orb]

Gittensory approves — the gate is satisfied and CI is green.