2026-08-20 — One release-notes format across the family
Documentation only. No source file, configuration file, or exported symbol changed.
@bayudwiyansatria/auth-client had the better shape for these two files, and the four repositories had drifted into
three variants of them. This adopts that shape here.
Release notes
docs/release-notes/1.0.0.md and 1.1.0.md were free-form prose under a bare # <version> heading. They now open with
# Release Notes and ## Version <x.y.z>, and the prose is sorted into the emoji sections the family uses — 📅 📖
🚀 🔧 ⚠️ 🔐 🧪 📚 🚨 📦 ⬆️ 👥 🙏 — closing with the line pointing at the GitHub repository.
Nothing was cut. The prose that explained why ConfigurationError exists, why Logger.fromEnv stopped naming a
platform, and why delivery belongs in the kernel rather than an adapter is all still there; it now sits under a
heading that says which kind of statement it is. The one thing a reader gains is the ability to answer "were there
breaking changes?" and "what are the known issues?" without reading the whole document, which is what a section skeleton
is for.
The section list itself is written down in
the publishing guide in
the sibling repositories, which have a guides/ directory. This one does not yet; adding it is deferred rather than
forgotten.
CHANGELOG
Three fixes:
- The
1.1.0section was missing entirely.package.jsonhas said1.1.0sinceDeliverySettingsshipped, anddocs/release-notes/1.1.0.mddocumented it, butCHANGELOG.mdstopped at1.0.0. It is now written up from those two sources, with the required-member addition under### Breaking Changeswhere it belongs. ## [Unreleased]added, matching the sibling repositories, so there is somewhere for the next change to land other than a new version heading.- The header now points at both directories —
docs/changes-log/for each work session anddocs/release-notes/for each release. It had named only the first, and called it "for each release", which is what the second is for.