Skip to content

Docs: condense the released changelog sections - #14

Merged
SandObserver merged 1 commit into
mainfrom
docs/condense-changelog
Aug 9, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/condense-changelog

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Condense every entry in the released sections (1.5.1 and earlier) to the change itself, dropping the trailing rationale. The file's stated rule is one minimal imperative line, with a second only when the reader must take an action; entries that name an action keep that sentence.
  • Normalise the blank lines between bullets, which the file mixed.
  • 645 lines to 517. Average entry length 24 words to 18. The worst section, 1.5.0, was 297 lines across 96 entries.

Verified mechanically rather than by eye: all 205 entries are still present, every surviving entry's opening statement appears verbatim in the previous revision, and no entry was merged, dropped or reworded into something new. Version headings, dates, the Keep a Changelog and Semantic Versioning links, and every compare link at the bottom are untouched.

Testing
All green. No new tests: documentation only.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

Entries for 1.5.0 and earlier carried the reasoning behind each fix as well as
the fix: why a parsing bug happened, what the old behaviour was, what the
alternative would have cost. The file's own rule is one minimal imperative line
per entry, with a second only when the reader has to do something.

Every entry is kept and no wording is invented: each keeps its opening
statement, and later sentences survive only where they tell the reader to act.
All 205 entries are still present, 645 lines down to 517.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 9, 2026
@SandObserver
SandObserver merged commit 96cd889 into main Aug 9, 2026
3 checks passed
@SandObserver
SandObserver deleted the docs/condense-changelog branch August 9, 2026 22:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant