From a387eaf26a197135ec79741ad424baa57ba87df1 Mon Sep 17 00:00:00 2001 From: Mohamed Boudra Date: Thu, 16 Apr 2026 19:16:42 +0700 Subject: [PATCH] docs: trim 0.1.58 changelog and add scannable-bullets guidance Split the OpenCode reliability bullet into four per-PR entries, shorten the Windows and provider-models bullets, and drop low-signal qualifiers. Add a "Changelog conciseness" section to the release playbook so the next agent knows bullets must be scannable in one glance. --- CHANGELOG.md | 15 +++++++++------ docs/RELEASE.md | 10 ++++++++++ 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a27cefd8..a2b7bf767 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,15 +3,18 @@ ## 0.1.58 - 2026-04-16 ### Added -- Markdown files render as formatted markdown in the file pane instead of raw source. ([#427](https://github.com/getpaseo/paseo/pull/427) by [@aaronflorey](https://github.com/aaronflorey)) -- Cmd+L (Ctrl+L on Windows/Linux) focuses the agent message input, with a hint shown when the agent panel is active. -- Provider model lists refresh on a freshness TTL, and Settings surfaces when models were last updated along with any fetch errors inline. ([#426](https://github.com/getpaseo/paseo/pull/426)) +- Markdown files render as formatted markdown in the file pane. ([#427](https://github.com/getpaseo/paseo/pull/427) by [@aaronflorey](https://github.com/aaronflorey)) +- Cmd+L (Ctrl+L on Windows/Linux) focuses the agent message input. +- Provider models refresh on a freshness TTL; Settings shows last-updated time and any fetch errors. ([#426](https://github.com/getpaseo/paseo/pull/426)) - `disallowedTools` option in provider config to block specific tools from an agent. ### Improved -- Windows: agents launch reliably across common install shapes. Claude, Codex, and OpenCode now start correctly from npm-installed `.cmd` shims, daemon paths containing spaces, and with JSON config arguments. Fixes `spawn EINVAL` and related startup errors that prevented Claude from starting on many Windows machines. ([#454](https://github.com/getpaseo/paseo/pull/454)) -- OpenCode reliability — permission prompts now include the requesting tool's context, todo and compaction events render in the timeline, sessions archive cleanly on close, and slash commands recover from SSE timeouts. ([#398](https://github.com/getpaseo/paseo/pull/398), [#407](https://github.com/getpaseo/paseo/pull/407), [#408](https://github.com/getpaseo/paseo/pull/408), [#429](https://github.com/getpaseo/paseo/pull/429) by [@aaronflorey](https://github.com/aaronflorey)) -- Paseo MCP tools work against archived agents, matching the CLI's behaviour. ([#423](https://github.com/getpaseo/paseo/pull/423)) +- Windows: agents launch reliably from npm `.cmd` shims, paths with spaces, and JSON config args — fixes `spawn EINVAL` startup errors. ([#454](https://github.com/getpaseo/paseo/pull/454)) +- OpenCode permission prompts include the requesting tool's context. ([#398](https://github.com/getpaseo/paseo/pull/398) by [@aaronflorey](https://github.com/aaronflorey)) +- OpenCode todo and compaction events render in the timeline. ([#429](https://github.com/getpaseo/paseo/pull/429) by [@aaronflorey](https://github.com/aaronflorey)) +- OpenCode sessions archive cleanly when closed. ([#408](https://github.com/getpaseo/paseo/pull/408) by [@aaronflorey](https://github.com/aaronflorey)) +- OpenCode slash commands recover from SSE timeouts. ([#407](https://github.com/getpaseo/paseo/pull/407) by [@aaronflorey](https://github.com/aaronflorey)) +- Paseo MCP tools work against archived agents, matching the CLI. ([#423](https://github.com/getpaseo/paseo/pull/423)) - Native scrollbars match the active theme across all web views. ([#399](https://github.com/getpaseo/paseo/pull/399) by [@ethersh](https://github.com/ethersh)) ### Fixed diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 54e288c70..6a838f66e 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -139,6 +139,16 @@ The changelog is shown on the Paseo homepage. Write it for **end users**, not de - **Only list changes relative to the previous stable release.** The diff is `v(previous)..HEAD`. If something was introduced and fixed between those two tags, it never shipped — don't mention the fix. - **Cut low-signal entries.** "Toolbar buttons have consistent sizing" is too granular. Combine small polish items or drop them. +## Changelog conciseness + +Every bullet must be scannable at a glance. The changelog is not release documentation — it's a list. + +- **One line per bullet.** If a bullet wraps to three lines in a narrow column, it's too long. +- **Split bullets that pack multiple distinct changes.** If a bullet uses "and", "plus", a comma list, or an em-dash to chain several independent improvements, break them into separate bullets — even when they share a theme or author. One bullet = one user-facing change. +- **Trim qualifying clauses.** Drop "with a hint shown when…", "matching the CLI's behaviour", "across common install shapes". If the detail doesn't change whether a user cares, cut it. +- **Lead with the outcome.** "Windows: agents launch reliably from npm `.cmd` shims…" is better than "Windows: agents launch reliably across common install shapes. Claude, Codex, and OpenCode now start correctly…". +- **Attribution follows the split.** When you split a dense bullet, move each PR/author to the bullet it belongs to. Never duplicate the same PR across multiple bullets. + ## Changelog attribution Every changelog bullet must credit contributors and link to the PR(s) that delivered the change. This is not one-PR-per-line — a single bullet describes a user-facing change and may reference multiple PRs.