Skip to content

Docs: rewrite documentation for concise, natural engineering prose - #5

Merged
etwk merged 1 commit into
mainfrom
docs/concise-rewrite
Oct 19, 2026
Merged

etwk merged 1 commit into
mainfrom
docs/concise-rewrite

Conversation

@etwk

@etwk etwk commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite README.md, docs/*.md, .env.example, and docker-compose.yml.example into natural, direct engineering prose (~21% smaller overall).
  • Eliminate cross-file repetition while preserving all protocol invariants, configuration defaults, error classification rules, and internal links/anchors.

Verification

  • Verified all 52 internal relative links and heading anchors across README.md and docs/*.md.
  • Validated docker compose -f docker-compose.yml.example config -q and go test.

@etwk
etwk merged commit 6846e0c into main Oct 19, 2026
2 checks passed
@etwk
etwk deleted the docs/concise-rewrite branch October 19, 2026 02:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant