docs: fix WRONG+HIGH tier doc-accuracy audit findings#85
Merged
Conversation
Correct nine shipped docs against current code and the live Python SDK (PyPI agentwrit v0.3.0), per the 2026-06-07 doc-accuracy audit. WRONG tier: - demos.md: replace coming-soon banner with live docker-compose run steps and the three published image names - python-sdk.md: drop fabricated register(launch_token=) API, document the real AgentWritApp/create_agent surface - faq.md: remove enterprise-module/open-core framing (Decision 022); mark SDK + demos shipped; event count 24 -> 25 HIGH tier: - common-tasks.md: sanitized validate-invalid response (no detail/codes); de-hardcode iss example - foundations.md: iss is config-driven (AA_ISSUER, empty default skips check), not always 'agentwrit' - SECURITY.md: add GitHub Security Advisory channel; real version table - design-decisions.md: planned OIDC bridge behind interface seam, not add-on - api.md: app/auth rate limit 10/min burst 3; event count 23 -> 25; add sid - openapi.yaml: details->detail + 8 missing event fields; policy fields; real SPIFFE shape Verified every fix against source; corrected two stale audit claims (event count is 25 not 26; release 403 insufficient_scope is correct). Co-authored-by: Claude <noreply@anthropic.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
devonartis
added
the
skip-changelog
Clears two Go stdlib advisories flagged by govulncheck: - GO-2026-5039 (net/textproto), reached via ed25519.GenerateKey - GO-2026-5037 (crypto/x509) Both fixed in go1.25.11. CI reads go-version-file: go.mod, so the toolchain directive bump applies across all jobs. Comment refs in ci.yml updated to match. Co-authored-by: Claude <noreply@anthropic.com>
Second pass over the 2026-06-07 audit (MED/LOW + cross-cutting), all
verified against current code:
- README.md: add missing POST /v1/app/launch-tokens row (19 endpoints)
- awrit-reference.md: config file is KEY=VALUE not YAML (MODE=/ADMIN_SECRET=);
audit IDs are evt-NNNNNN not UUID; app deregister status is 'inactive'
- troubleshooting.md: go run -> ./bin/; /v1/register has no requested_ttl
(TTL comes from launch-token max_ttl); config path is /etc/broker/config
- concepts.md: hash covers 13 fields; claims include iss/nbf/aud/sid;
eight components (was 'seven')
- security-topology.md + 2 SVG diagrams: 24 -> 25 event types
- architecture.md: prometheus/client_model marked indirect (5 direct deps)
- implementation-map.md + scenarios.md: mutauth built+tested but NOT mounted
- getting-started-{user,operator}.md: go run -> ./bin/
- CHANGELOG.md: [Unreleased] docs-accuracy + Go toolchain entries
Deferred: RFC 7807-vs-9457 reconciliation (code emits 7807, rules say 9457
— owner decision, out of docs-only scope). AGENTS.md/CONTRIBUTING.md fixes
are local-only (both gitignored, not tracked in this repo).
Co-authored-by: Claude <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.
Corrects nine shipped docs against current code and the live Python SDK (PyPI `agentwrit` v0.3.0), per the 2026-06-07 doc-accuracy audit. Every fix verified against source — caught two stale audit claims (event count is 25 not 26; release 403 `insufficient_scope` is correct as-shipped).
WRONG tier
HIGH tier
Verification
MED/LOW audit tiers are a separate follow-up sweep.