docs: add working-with-state standard; home both standards in-repo#16
Merged
Conversation
Adds docs/working-with-state.md — the non-secret on-disk state standard (config + cache) and the LOCKED rollout plan, companion pillar to the Secret-Handling Standard. Pressure-tested through 5 Codex architect rounds (converged blockers=0 majors=0 minors=0 nits=0; disposition in §7). Moves working-with-secrets.md from a loose unversioned ~/dev file into docs/ so both standards co-version with the cli-common code, and updates the README to reference them in-repo (the prior "maintained outside this repository" note no longer holds). Closes #15 [MON-5362]
After homing the file under docs/, the relative [name](name) links resolved to docs/cli-deployment-manifest.md (nonexistent in-repo). That manifest is an unpublished loose doc; reference it by bare name, matching how the README handles unpublished standards. [MON-5362]
Contributor
Author
|
Major resolved. On PR head No regressions seen: changed files remain exactly README plus the two docs; README links still point to files added by the PR; |
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
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.
Summary
docs/working-with-state.md— the non-secret on-disk state standard (config + cache) and the LOCKED rollout plan. Companion pillar to the Secret-Handling Standard.working-with-secrets.mdindocs/(clean move from a loose unversioned~/dev/file) so both standards co-version with thecli-commoncode they govern.README.mdto reference both standards in-repo (the prior "maintained outside this repository / not published" note no longer holds).Standard highlights (
working-with-state.md)os.UserConfigDir()/<dir>, Cache →os.UserCacheDir()/<tool>, via a sharedcli-commonstate resolver; native per-OS, no hand-rolled current/target path resolution (bespoke legacy probes exempt).Review provenance
Pressure-tested through 5 Codex architect rounds (gpt-5.5, xhigh). Round 1 caught 2 blockers + 6 majors (real factual errors fact-checked against the sibling repos — all fixed). Converged at round 5:
blockers=0 majors=0 minors=0 nits=0. Full per-finding disposition is in §7 of the doc.Test plan
make checkunaffected (verify CI).cli-commonstate components; per-unit ports.Closes #15
[MON-5362]