Skip to content

docs(miner-foundation): gittensory-miner and gittensory-engine README + package docs #2298

Description

@JSONbored

Write the user-facing README for packages/gittensory-miner/ (install, gittensory-miner status/doctor usage, the .gittensory-miner.yml config file, the explicit "100% local — never uploads source, never holds shared credentials" boundary statement) and flesh out packages/gittensory-engine/'s README (its purpose as the shared deterministic-logic package, its version-pin guarantee, and that it is an internal dependency of both the review-stack backend and gittensory-miner rather than a package end users install directly). Mirror packages/gittensory-mcp/README.md's structure (Status / Install / Commands sections) so the three sibling packages read consistently.

Deliverables

  • packages/gittensory-miner/README.md — Status (what's implemented so far: foundation-only, no live discovery/coding-agent loop yet), Install (npm install -g @jsonbored/gittensory-miner once published, or npm link --workspace from a local checkout, mirroring gittensory-mcp's two install paths), Commands (status, doctor, --help, --version), and a .gittensory-miner.yml config-file section pointing at .gittensory-miner.yml.example.
  • packages/gittensory-engine/README.md — purpose, version-pin guarantee (cites the ENGINE_VERSION constant), explicit "not meant to be installed standalone by end users" framing, and a short list of what it currently exports (predicted-gate, slop, focus-manifest, reward-risk, scoring, duplicate-winner — update as extraction issues land) with a note to keep this list current as more modules move in.
  • Root README.md gains a short new bullet/section under wherever it currently lists the packages/gittensory-mcp package, introducing gittensory-engine and gittensory-miner at a one-paragraph level with links to their own READMEs.
  • npm run ui:version-audit-equivalent sanity check (or a simple grep-based test) confirming the miner README's stated version matches its package.json version, mirroring the existing scripts/check-ui-mcp-version-copy.mjs pattern's spirit for the mcp package.

References

  • packages/gittensory-mcp/README.md (full file) — the structural template (Status / Install / Commands sections) to mirror for both new package READMEs.
  • README.md (root, 7867 bytes) — where the new packages get a top-level mention.
  • scripts/check-ui-mcp-version-copy.mjs — existing version-copy-drift-check precedent to mirror the spirit of (does not need to reuse this exact script, but the same drift class should be caught).

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

    Status
    In Progress

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions