docs(miner): document all sixteen local SQLite stores in DEPLOYMENT.md (#4870) - #5524
Conversation
…otes This update enhances the DEPLOYMENT.md documentation by adding new database files related to the gittensory-miner, including `laptop-state.sqlite3`, `run-state.sqlite3`, and various caches for policy verdicts and telemetry. It also clarifies the conditions under which these files are created and how to override their storage locations. This ensures users have a comprehensive understanding of the miner's configuration and state management. Closes JSONbored#4842, JSONbored#4843, JSONbored#4277, JSONbored#4522, JSONbored#4263, JSONbored#3010, JSONbored#5134, JSONbored#4294, JSONbored#4297, JSONbored#2328, JSONbored#2290, JSONbored#2314, JSONbored#2318.
|
🚨 Contributor flagged. Click here for more info: Superagent Dashboard |
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-13 04:02:35 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Flagged checks (non-blocking)
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands 🟩 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.
|
Summary
packages/gittensory-miner/DEPLOYMENT.md's "expected layout" section listed only 5 of the miner's local SQLite stores (claim-ledger,plan-store,portfolio-queue,event-ledger,governor-ledger), but the package actually creates 16. An operator following the doc would miss most of their own on-disk state — the exact problem #4870 reports.This rewrites the layout to list every store the package creates, each with its filename, a one-line purpose, and its issue ref:
laptop-state(init state),portfolio-queue(feat(miner-foundation): local portfolio/queue store for gittensory-miner #2292),claim-ledger(feat(miner-foundation): local claim-ledger SQLite schema + CRUD in packages/gittensory-miner #2314),plan-store(feat(miner-foundation): local SQLite persistence adapter for the stateless MCP plan DAG #2318),run-state,event-ledger(feat(miner-foundation): immutable event ledger for gittensory-miner #2290),governor-ledger(feat(miner-governor): append-only local event ledger schema + writer #2328),governor-state(Persist governor cross-attempt state (rate-limit, budget, convergence, reputation, self-plagiarism) #5134),attempt-log(feat(miner-hands): driver-level structured attempt log (JSONL event trace per attempt) #4294),worktree-allocator(feat(miner-concurrency): add git-worktree-per-attempt allocator #4297),prediction-ledger(feat(miner-selfimprove): local prediction-ledger schema — record every predicted-gate verdict for later scoring #4263),replay-snapshot(feat(miner): freeze/snapshot mechanism for historical replay targets #3010),policy-doc-cache(Add conditional-GET caching for policy-doc fetches #4842),policy-verdict-cache(Add a persisted cross-invocation cache of resolved policy verdicts #4843),deny-hook-synthesis(feat(miner): synthesize PreToolUse deny-hook rules from the review stack's own per-repo close/blocker finding-category history #4522),orb-export(feat(miner-manage): optional anonymized Orb telemetry export for miner outcomes #4277).It also adds two accuracy notes: files are created lazily (only once the relevant subsystem first runs, so a fresh
status/doctor-only install shows a subset), and every store exceptlaptop-statehonors its ownGITTENSORY_MINER_<NAME>_DBpath override in addition to the directory-levelGITTENSORY_MINER_CONFIG_DIR.Every filename and env-var name was verified directly against the store modules in
packages/gittensory-miner/lib(all 16.sqlite3defaults; none exist outsidelib/), so the list is complete and exact.Closes #4870
Scope
type(scope): short summaryConventional Commit format.CONTRIBUTING.mdand does not reintroduce GitHub Pages, VitePress,site/, orCNAME.Validation
git diff --checknpm run docs:drift-check(passes — the generated-docs drift check is unaffected)npm run typecheck/test:*/build:*/ui:*— N/A: single hand-written Markdown doc change, no code, schema, or generated artifact touched.*.sqlite3default inpackages/gittensory-miner/lib(16) and confirming none exist elsewhere in the package.If any required check was skipped, explain why:
Documentation-only change to one Markdown file (
DEPLOYMENT.md); it touches no source, tests, schemas, or generated artifacts, so the build/type/UI/coverage checks are N/A.Safety
UI Evidence
N/A — Markdown documentation change only.
Notes