docs: documentation audit — populate CHANGELOG, fix stale README recipes - #20
Merged
Conversation
Audited human-facing Markdown against the live repo after the v0.1.5→HEAD work (15 merged PRs). CHANGELOG: the [Unreleased] section was empty despite a hardening release worth of changes. Populated it (Keep a Changelog groups) from the merged PRs — CI + smoke, boot-event observability, IPv6 filtering, fail-closed firewall, pinned/ verified build, DNS/SSH exfil-channel closure, AWS region jq fix, cron→Postgres env, profile-aware teardown, NET_RAW drop, and the docs/CLAUDE.md work. No new tag cut (release decision is separate). All six existing tag dates verified against git and left intact. README: - permissive-mode recipe now uses --force-recreate; FIREWALL_MODE is read at container create time, so a plain `up -d`/`restart` won't switch it (was actively misleading). - "UDP 53 is always allowed" -> "DNS to the container's resolver is allowed", reconciled with the DNS-scoping hardening. - DB quickstart: fixed the dangling colon (precondition prose sat between the colon and its code block). - Layout: added log-event.sh. docs/findings/README.md: added a "Status: remediated" banner linking to REMEDIATION.md so the pre-remediation snapshot isn't misread as current state. SECURITY.md left as-is (accurate at policy altitude). No README split (single audience). Verified: all README Make commands exist, no dead internal links. Co-Authored-By: Claude Opus 4.8 (1M context) <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.
What
A
/documentation-auditpass over the human-facing Markdown (README, CHANGELOG, SECURITY, findings index), verified against the live repo after the v0.1.5→HEAD work (15 merged PRs).CHANGELOG — headline fix
[Unreleased]was empty despite a hardening release worth of changes. The CHANGELOG is manually maintained (no release tooling owns it), so I populated[Unreleased]with Keep-a-Changelog groups drawn from the merged PRs:.dockerignoreclaude update, NET_RAW dropNo new tag cut (release decision is separate). All six existing tag dates verified against
git logand left intact.README — stale/misleading fixes
--force-recreateadded to the permissive-mode recipe (the oldup -dform silently won't switchFIREWALL_MODEon a running container).log-event.shadded to the Layout tree.findings index
Added a "Status: remediated" banner → REMEDIATION.md so the pre-remediation snapshot (public repo) isn't misread as current security state.
Deliberate non-changes
Verification
All 19 README Make commands exist; tag dates match
git log;markdown-link-checkclean (no 404/410); every referenced path exists.Docs-only.
Generated with Claude Code (https://claude.com/claude-code)