Skip to content

fix: clarify audit scope in README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devonartis merged 3 commits into from
Apr 13, 2026
Merged

fix: clarify audit scope in README #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a384d3c
fix: clarify audit scope in README — credential events, not agent act…
devonartis Apr 13, 2026
b242751
docs: README overhaul for scannability and wayfinding
devonartis Apr 13, 2026
5d92b55
docs: add CHANGELOG entry for README overhaul
devonartis Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed — README overhaul for scannability and wayfinding (2026-04-13)

- **`README.md`** — full restructure for newcomers who scan, not read:
- Quick Start collapsed to one path (Docker Hub), 5 commands, no inline explanations. "Next steps" decision table immediately after.
- "Why this matters" side-by-side comparison table replaces prose bullet list.
- "How it works" simplified mermaid flow with numbered steps. Component table links to source packages.
- API table adds "Who uses it" column so each role finds their endpoints fast.
- Documentation section reframed as "I want to..." intent-based navigation.
- Configuration collapsed to one essential table + link to operator guide.
- TLS/mTLS/nginx config, cosign verification, image tag details moved to docs (not README).
- Audit trail wording clarified: broker logs credential lifecycle events, not agent activity at the resource server.
- Net: 169 insertions, 469 deletions — README is now a landing page, not a manual.

### Fixed — stale agentauth brand refs missed in rebrand (2026-04-13)

- **`SECURITY.md`** — contact emails `security@agentauth.dev` → `security@agentwrit.com`; all "AgentAuth" brand references → "AgentWrit".
Expand Down
Loading
Loading