docs: audit and refresh docs to match shipped features#12
Merged
Conversation
Bring README, user guide, AI reference, and `aigate help-ai` back in sync with the code after the dashboard, IPv6, masking, and Go-version changes. - Document `aigate serve` (local web dashboard) and the `~/.aigate/audit.jsonl` audit log (run_started / blocked events) — previously undocumented entirely. - Sync the default-config example in the user guide with InitDefaultConfig: add *.p12, terraform.tfstate, *.tfvars; ncat/netcat/rsync/ftp; registry.npmjs.org, proxy.golang.org; and the mask_stdout block init writes. - Add the aws_secret preset (6 presets, not 5) to the user guide table and help-ai; fix its description (matches AWS_SECRET_ACCESS_KEY= assignments). - README: Go badge 1.24+ -> 1.25+; drop the "cgroups limits enforced" claim (the user guide already notes limits are not yet enforced). - AI reference: add audit_service.go, masker.go, internal/web/, setup.go, help_ai.go, and the escape tests to the architecture map; note the append-only audit log + read-only dashboard design. - help-ai: add `doctor` to setup and a DASHBOARD & AUDIT LOG section. Verified: go build ./... and go test -short ./... pass. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
StructLint — All checks passed92 rules validated against
|
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.
What
A docs audit + refresh to bring all four user-facing doc surfaces back in sync with what actually ships. Recent PRs (dashboard #9, IPv6 #10, Go bump #11, and earlier masking) added features and changed defaults that never made it into the docs.
Kept it useful and tight — no bloat, just fixing what was missing or wrong.
Gaps fixed
aigate serve/ web dashboardhelp-ai~/.aigate/audit.jsonl)help-ai, with event examples*.p12,terraform.tfstate,*.tfvars,ncat/netcat/rsync/ftp,registry.npmjs.org,proxy.golang.org, and the wholemask_stdoutblockInitDefaultConfigaws_secretpresetAWS_SECRET_ACCESS_KEY=match), "6 presets"1.24+, "From Source (Go 1.24+)"1.25+(go.mod is 1.25.11)audit_service.go,masker.go,internal/web/,setup.go,help_ai.go, escape testshelp-aidoctor, noserve/dashboarddoctorto setup + a DASHBOARD & AUDIT LOG sectionFiles
README.mddocs/user/README.mddocs/AI/README.mdactions/help_ai.go(theaigate help-aioutput)Verified
go build ./...andgo test -short ./...pass🤖 Generated with Claude Code