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.

[codecov]

⚠️ JUnit XML file not found

The CLI was unable to find any JUnit XML files to upload.
For more help, visit our troubleshooting guide.

[loopover-orb]

Caution

🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥🟥

🛑 Gittensory review result - fixes required

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

4 files · 1 AI reviewer · no blockers · readiness 80/100 · CI failing · blocked

🛑 Suggested Action - Fix Blockers

Review summary
Adds three additive files — a JSON Schema draft 2020-12 for `.gittensory-miner.yml`, a field-reference doc, and a regression test that round-trips the repo's own `.gittensory-miner.yml.example` through `parseMinerGoalSpecContent` — plus a two-line README pointer. All seven `MinerGoalSpec` fields (`minerEnabled`, `wantedPaths`, `blockedPaths`, `preferredLabels`, `blockedLabels`, `maxConcurrentClaims`, `issueDiscoveryPolicy`) are consistently named and defaulted across the schema, doc, and test, and the doc's discovery-order list matches the engine's documented `MINER_GOAL_SPEC_FILENAMES` order. The test's relative import path (`test/unit/` → `../../packages/gittensory-engine/src/miner-goal-spec`) resolves correctly, and the PR closes its linked issue (#2300) with scope matching the description — a clean, narrow docs/schema contribution.

Nits — 5 non-blocking

• The JSON Schema's per-field descriptions duplicate the prose in miner-goal-spec.md verbatim — consider having one be the source of truth (e.g. schema descriptions reference the doc) so they don't drift when a default changes.
• packages/gittensory-miner/schema/miner-goal-spec.schema.json has no `required` array, which is correct per 'every field is optional,' but worth a one-line comment/doc note confirming that's intentional rather than an oversight, since most hand-authored schemas do declare required fields.
• test/unit/miner-goal-spec-doc.test.ts's field-presence check (`expect(doc).toContain(field)`) is a weak substring match — e.g. `blockedLabels` would also match if only mentioned in passing text rather than as a documented heading; consider asserting each field has its own `### \`field\`` heading.
• Consider adding a CI/build-time check (or extending this test) that diffs the schema's property list against the engine's actual `MinerGoalSpec` TypeScript type/keys, so a future field addition to the parser can't silently go undocumented.
• The schema's `$id` (https:​//jsonbored.dev/schemas/gittensory-miner-goal-spec.json) is not shown to be hosted/resolvable anywhere in this diff — verify that URL is either real or clearly marked as a placeholder to avoid a broken schema reference for downstream tooling.

CI checks failing

• validate
• validate-code

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

[loopover-orb]

Gittensory is closing this pull request on the maintainer's behalf (CI is failing (validate, validate-code)). This is an automated maintenance action — to pursue this change, please open a new pull request with the issues resolved. Closed PRs may be analyzed later to improve review accuracy, but they are not automatically reopened or re-reviewed.