Repository navigation
docs: fix first-day default-path accuracy (USAi, backend primacy, dead links) - #345
Merged
Merged
Conversation
…d links) First-day default-path (msb) doc-accuracy batch from the audit epic #335. Docs only — no acq/backend/config change. #337 — repointed the broken local `docs/CODING_PRACTICES.md` references (that file lives in the playbook, not here — "reference, don't restate") to the canonical playbook URL used already by AGENTS.md/QUICKSTART_SBX.md: 5 sites in CONTRIBUTING.md + the CONTEXT-GUIDE.md table row; dropped the non-existent path from CONTEXT-GUIDE.md `related_files`. (checklists/pre-deployment.md:11 is the same defect but is deferred — it collides with open PR #344; will fold in after that merges.) #336 — defined USAi on first mention in README ("the GSA-hosted LLM gateway at api.gsa.usai.gov") and reconciled the misleading "Nothing to get in advance" key row: the code hard-aborts without a key (acq.backends/common.sh), so the row now says "Required, but acq guides you" and flags that non-interactive/CI has no prompt and needs the key set in advance. #338 — resolved the competing backend-primacy claims. QUICKSTART_SBX's "Recommended for federal users" steered readers to the NON-default backend; replaced it with a note that msb is the default and this guide is for when you specifically want sbx. Surfaced the real msb constraint where a reader chooses (BACKEND_GUIDE "Known limitations"): acq can auto-install only opencode on msb; other agents must be pre-baked into ACQ_MSB_IMAGE. #343 — the sandbox no longer "clones" the playbook after the #327 heal-probe moved to an AGENTS.md marker (delivery is a pinned REST tarball, patterns v1.8.0+). Fixed the stale "clones" prose at 4 user-facing sites the audit's 2 cites missed (README x2, risk-assessment x2) to delivery-accurate wording. #340 (quickstart) — the QUICKSTART msb export block leaked the key into shell history and read as a normal default step. Marked it interactive-vs-non-interactive, cross-linked the safe `acq secret set -g usai` flow, and replaced the inline `export KEY=<...>` with a `read -rs` prompt that never lands in history/argv. markdownlint clean (10 files); new/changed external URLs verified 200. Refs #335 #336 #337 #338 #340 #343 Co-authored-by: OpenCode Agent <[email protected]>
This was referenced Aug 20, 2026
Closed
Contributor
Author
|
Merging per maintainer (wz-gsa) sign-off after full diff review (author can't self-approve). First-day default-path doc accuracy: USAi defined + key-claim reconciled with the hard abort; CODING_PRACTICES.md → playbook URL; msb-is-default primacy; clones→tarball; QUICKSTART key-leak → read -rs. markdownlint + link-check + pre-commit green. Note: #344 (which also edited pre-deployment.md) has merged, so the deferred #337 line-11 residual is now unblocked for a small follow-up. |
mogul
pushed a commit
that referenced
this pull request
Aug 21, 2026
… URL (#337) (#356) Residual of #337 — deferred in merged PR #345 because the pre-deployment.md ref collided with open PR #344 (SA-12→SR-3), which has since merged. That file lives in the agentic-coding-playbook, not here ("reference, don't restate"), so point at the canonical playbook URL already used by the other refs. Two live local refs remained (audit + #345 fixed the rest; this is the tail): - checklists/pre-deployment.md:11 — related_files entry → full playbook URL - docs/adr/0002-...:239 — the "Related:" prose ref → linked playbook URL Left as-is (correctly): AGENTS.md:229 and ADR-0002:186/206 mention CODING_PRACTICES.md as PROSE describing what a section adds to the playbook doc, not as links/paths to a local file. No remaining local docs/CODING_PRACTICES.md path references (verified). markdownlint clean. Closes #337
This was referenced Aug 22, 2026
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.
First-day default-path (msb) doc-accuracy batch from the audit epic #335. Docs only — no
acq/backend/config change.#337 — dead
docs/CODING_PRACTICES.mdlinksThat file lives in the playbook, not here ("reference, don't restate"). Repointed the broken local refs to the canonical playbook URL already used by
AGENTS.md/QUICKSTART_SBX.md: 5 inCONTRIBUTING.md+ theCONTEXT-GUIDE.mdtable row; dropped the non-existent path fromCONTEXT-GUIDE.mdrelated_files.#336 — USAi undefined + contradictory key claim
Defined USAi on first mention (README: "the GSA-hosted LLM gateway at
api.gsa.usai.gov"). The code hard-aborts without a key (common.sh), so the misleading "Nothing to get in advance" row is now "Required, butacqguides you" and flags that non-interactive/CI has no prompt → key must be set in advance.#338 — competing backend-primacy claims
QUICKSTART_SBX's "Recommended for federal users" steered readers to the non-default backend. Replaced with a note that msb is the default and this guide is for when you specifically want sbx. Surfaced the real msb constraint where a reader chooses (BACKEND_GUIDEKnown limitations):acqcan auto-install onlyopencodeon msb; other agents must be pre-baked intoACQ_MSB_IMAGE.#343 — stale "clones" prose
After #327 moved the heal-probe to an
AGENTS.mdmarker, delivery is a pinned REST tarball (patterns v1.8.0+), not a clone. Fixed the stale "clones" wording at 4 user-facing sites (the audit's 2 cites missed README ×2 extra + risk-assessment).#340 — QUICKSTART export leaked the key into shell history
Marked the block interactive-vs-non-interactive, cross-linked the safe
acq secret set -g usaiflow, and replaced inlineexport KEY=<...>with aread -rsprompt that never lands in history/argv.Verification
markdownlint clean (10 files); new/changed external URLs verified 200; pre-commit (gitleaks + secrets) green.
Refs #335 #336 #337 #338 #340 #343
AI-assisted (OpenCode).