-
-
Notifications
You must be signed in to change notification settings - Fork 254
Description
Now that we have proper automated formatting of the release notes in GitHub releases, the next step would be to automate a changelog page being rendered on the docs.
This would replace the manual edit of this comment, and allow presenting changes in a better manner. The idea of this comment was being able to quickly scan releases to find a particular thing (so no pagination, unless it makes it too large in the DOM).
Some inspiration could be taken from the way the nuqs 2.5 changelog was presented in the blog:
- Rendered: https://nuqs.dev/blog/nuqs-2.5#full-changelog
- PullRequestLine component: https://github.com/47ng/nuqs/blob/next/packages/docs/src/components/ui/pr-line.tsx
It should follow the way releases are rendered on GitHub:
- Sorted by category (features, bug fixes, documentation, other changes)
- With attribution for contributors (not only PR authors, but also issue participants that bring feedback & discussion)
The page could live at https://nuqs.dev/changelog, and should be static, ISR-invalidated when a new release is available (as part of the CI/CD deployment process, once we've edited the GitHub release notes).