Skip to content

docs: add working-with-state standard; home both standards in-repo#16

Merged
rianjs merged 2 commits into
mainfrom
docs/working-with-state
May 19, 2026
Merged

docs: add working-with-state standard; home both standards in-repo#16
rianjs merged 2 commits into
mainfrom
docs/working-with-state

Conversation

@rianjs
Copy link
Copy Markdown
Contributor

@rianjs rianjs commented May 19, 2026

Summary

  • 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.
  • Homes working-with-secrets.md in docs/ (clean move from a loose unversioned ~/dev/ file) so both standards co-version with the cli-common code they govern.
  • Updates README.md to reference both standards in-repo (the prior "maintained outside this repository / not published" note no longer holds).

Standard highlights (working-with-state.md)

  • Config → os.UserConfigDir()/<dir>, Cache → os.UserCacheDir()/<tool>, via a shared cli-common state resolver; native per-OS, no hand-rolled current/target path resolution (bespoke legacy probes exempt).
  • Rollout: commons-first, port one unit at a time (a unit = a CLI / a credential scope / a cache-only surface); jtk-cache first and independent; Atlassian shared config is one combined cfl+jtk unit; per-port §3.2 migration acceptance matrix as a merge gate; 7-var hermetic test isolation.

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

  • Docs-only + README change — no code; make check unaffected (verify CI).
  • Confirm both standards render and the README in-repo links resolve.
  • Follow-ups (not this PR): build the cli-common state components; per-unit ports.

Closes #15
[MON-5362]

rianjs added 2 commits May 19, 2026 07:33
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]
@rianjs
Copy link
Copy Markdown
Contributor Author

rianjs commented May 19, 2026

Major resolved. On PR head 8419a6c, the cli-deployment-manifest.md references in docs/working-with-secrets.md are now code spans, not relative Markdown links.

No regressions seen: changed files remain exactly README plus the two docs; README links still point to files added by the PR; working-with-state.md is unchanged from the converged version.

@rianjs rianjs merged commit fbc6085 into main May 19, 2026
4 checks passed
@rianjs rianjs deleted the docs/working-with-state branch May 19, 2026 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize non-secret on-disk state (config+cache) across the Go CLI family

1 participant