Skip to content

Docs: state the unreleased entries as facts about the software - #130

Merged
SandObserver merged 1 commit into
mainfrom
docs/changelog-entry-wording
Aug 19, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/changelog-entry-wording

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • Split the System Summary entry in two, so the sources and the throughput row each get one line.
  • Drop the second person from the throughput and settings-form entries.
  • Shorten the settings-form entry to the fact about the software.

node scripts/changelog-check.js reported three warnings on these entries: two for addressing the reader, one for a 178-character entry against the 160 limit. It now reports none.

Testing
All green, including the changelog check and the Docker build. No code changed.

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.

Three entries addressed the reader and one ran past a single line, which the
changelog check reports. The throughput note becomes its own entry rather than a
clause on the provider one.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 19, 2026
@SandObserver
SandObserver merged commit e8a2f18 into main Aug 19, 2026
3 checks passed
@SandObserver
SandObserver deleted the docs/changelog-entry-wording branch August 19, 2026 00:10
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