-
Notifications
You must be signed in to change notification settings - Fork 9
Consolidate release notes for patch versions under the same minor version #53
Description
Right now, we grab the release notes for every patch version of every release. This is a little bit noisy, and makes it harder for people to quickly scan the releases to see what we're adding.
Suggestion: Create a single release roll-up for the last N releases of each package
List one page for all releases of a package, and vertically concatenate them into one page, so that you can quickly scroll through the changes in a repository. In the index page table, we continue listing the latest releases sorted by date, with links to the respective release page for the relevant tool.
- For each tool we specify in the repository
- For each major, minor, and patch release over the last N months (12 ?)
- Grab the release notes from github
- Convert their headers (
## Enhancementsetc) into bolded headers (to reduce TOC noise) - Keep the release name as a
##header - Provide Links to the original release notes of each on github, just beneath the title of that release.
- Concatenate all of them into a single set of release notes
I think this would make it easier to use the releases page as a quick reference to learn how things are evolving, and shouldn't be too much work.
Inspiration
Most projects seem to have a single page that you can continuously scroll down (similar to CHANGELOG.md). Here are two that look really nice:
Zen Browser:
Obsidian:

