docs(readme): document local state dir + PINAKES_STATE_ROOT#52
Merged
Conversation
…rride The standalone-decoupling audit (Work Stream A1) flagged that the default local snapshot-store path (<os.UserCacheDir>/pinakes) and the PINAKES_STATE_ROOT override were only in code comments + the ebola case study, with no pointer in the main README for a user to find/back-up/clear local state. Add a short "Local state" section. Docs only. No engine/idl/schema change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: document local state dir + PINAKES_STATE_ROOT
From the standalone-release decoupling audit (Work Stream A1, verdict: CLEAN — the engine is
already standalone-ready, no decoupling code needed). The audit's one actionable doc nit: the
default local snapshot-store path and its override had no pointer in the main README.
<os.UserCacheDir>/pinakes(~/Library/Caches/pinakeson macOS,$XDG_CACHE_HOME/pinakeselse
~/.cache/pinakeson Linux), auto-created on first run.PINAKES_STATE_ROOT.pinakes verifyre-runs read this dir with no network.The audit's other nit (
PINAKES_API_KEYfuture-tier clarity) is already covered at README.md:225,so no change there. Docs-only; no
engine//idl//schema/.🤖 Generated with Claude Code