docs: align AI-facing discovery surfaces after architecture vNext#216
Merged
Conversation
The 2026-05-11 architecture retest confirmed Architecture vNext is functionally closed on main (PRs #209-#215) but found three P2 documentation drifts that this follow-up resolves. Finding 1: AI-facing surfaces pointed at a non-existent reference/telemetry.md path. llms.txt and bin/about.sh now reference TELEMETRY.md, the canonical file the READMEs already linked to. Finding 2: AGENTS.md claimed to list every shipped skill but the table only had eight entries; the README sells 13. Grouped the table into three sections (default sprint / orchestration and safety / onboarding and entry points) and added compound, feature, nano-run, nano-help, and nano-doctor. Finding 3: README.md mentioned auto-saved artifacts and the resolver but did not reflect the Architecture vNext guarantees the retest just proved. Tightened three existing sections: - Artifacts now mentions the SHA-256 integrity field, --require-integrity for strict consumers, and the schema_legacy marker on --from-session legacy artifacts. - Resolver now mentions upstream_status (the four trust values) and the phase_context block that lets custom skills declare trust: strict, max_age_days, required vs optional upstreams, and tagged solution / diarization lookup. routing in the JSON output exposes what the resolver applied. - Write/Edit guard section now mentions the credential JSON basenames it blocks (credentials.json, secrets.json, service-account*.json, firebase-adminsdk*.json, google-credentials*.json, aws-credentials*.json) plus the safe-template exception (.env.example, credentials.example.json, service-account.template.json) and the case-insensitive match. Lint adds architecture-vnext-doc-locks with three steps: - Telemetry path is TELEMETRY.md, not reference/telemetry.md, and llms.txt + bin/about.sh both mention TELEMETRY.md. - AGENTS.md mentions compound, feature, nano-run, nano-help, and a doctor variant (nano-doctor, /doctor, or doctor/SKILL). - README.md mentions --require-integrity, phase_context, upstream_status, at least one credential JSON name, and at least one safe-template shape. Each lock was sabotage-tested (reintroduce the dead path / delete a required token / strip --require-integrity); all three caught the drift cleanly. No runtime behavior changes; all existing E2E suites remain green. Closes the three P2 doc findings from the 2026-05-11 Architecture vNext fresh retest spec.
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
The 2026-05-11 Architecture vNext fresh retest spec confirmed the round is functionally closed on main (PRs #209-#215, all seven contracts retested green) and surfaced three P2 documentation drifts as a follow-up. This PR resolves all three and adds a lint lock per finding so the drift cannot return.
What changes
Finding 1 — Telemetry doc path.
llms.txtandbin/about.sh --printpointed agents atreference/telemetry.md, a file that does not exist. The canonical file the READMEs already linked to isTELEMETRY.md. Both surfaces now point atTELEMETRY.md.Finding 2 — AGENTS.md inventory. AGENTS.md claimed to list every shipped skill but the table only had eight entries (think, nano, review, qa, security, ship, guard, conductor). The README sells 13 built-in skills. Took Option A from the retest spec (complete inventory) and grouped the table into three sections:
Finding 3 — README reflects Architecture vNext guarantees. README.md mentioned auto-saved artifacts and the resolver but did not reflect the contracts the retest just proved. Tightened three existing sections in place (no marketing churn, no banned public-copy claims):
integrityfield,bin/find-artifact.sh --require-integrityfor strict consumers, and theschema_legacy: truemarker on legacy--from-sessionartifacts.upstream_status(verified / integrity_missing / integrity_mismatch / missing) and thephase_contextblock that lets custom skills declaretrust: strict,max_age_days, required vs optional upstreams, and tagged solution / diarization lookup. The applied context comes back inroutingso consumers see what the resolver did.credentials.json,secrets.json,service-account*.json,firebase-adminsdk*.json,google-credentials*.json,aws-credentials*.json) and the safe-template exception (.env.example,credentials.example.json,service-account.template.json). Match is case-insensitive and mirrors the read-side G-035 rule.Lint. New
architecture-vnext-doc-locksjob with three steps:reference/telemetry.mddoes not appear in any AI-facing surface, and llms.txt + bin/about.sh both containTELEMETRY.md.compound,feature,nano-run,nano-help, and a doctor variant.--require-integrity,phase_context,upstream_status, at least one credential JSON name, and at least one safe-template shape.Each lock was sabotage-tested locally:
reference/telemetry.md→ caught.compoundfrom AGENTS.md → caught.--require-integrityfrom README → caught.What does not change
tests/run.sh(83) andtests/e2e-user-flows.sh(5).Codex review
Single pass clean: "The changes are documentation and CI lock additions that are syntactically valid and consistent with the referenced files. I did not find a discrete introduced issue that would break existing behavior or tests."
Spec
Follow-up to the 2026-05-11 Architecture vNext fresh retest. Closes the three P2 documentation findings in that spec:
Architecture vNext itself (PRs #209-#215) stays closed.
Test plan
.github/workflows/lint.ymlarchitecture-vnext-doc-locksjob passes on CI.bin/about.sh --print | grep TELEMETRY.mdfinds the corrected path.grep -nF 'reference/telemetry.md' llms.txt bin/about.sh AGENTS.md README.md README.es.mdreturns nothing.reference/telemetry.mdin llms.txt and confirm the new lock fails CI.