docs: hardening plan, ADRs, and rewritten README/docs - #6
Merged
Conversation
Adds a hardening plan (docs/plan.md) derived from a full code review, covering durability, mail-loss, mail-auth correctness, DoS hardening, security mitigations, and CI gates. Records the load-bearing decisions as ADRs 001-004 and seeds docs/roadmap.md. docs/plan.md is force-added because the global gitignore excludes plan.md; it is intentionally tracked here as project documentation.
Rewrites the README to reflect the actual feature set (auth, SPF/DKIM/ DMARC, outbound delivery, observability) and to be candid about config knobs that are parsed but not yet enforced. Adds a full configuration reference and an operations guide, plus a docs index. Ignores .claude/scratch (ephemeral agent outputs).
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.
Adds documentation derived from a full code review of smtpd.
What's here
Docs only; no code changes.