Skip to content

doc/guides: add riot changelog #21741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 20 commits into
base: master
Choose a base branch
from
Open

doc/guides: add riot changelog #21741

wants to merge 20 commits into from
+1,653 −1,638

Conversation

LasseRosenow
Copy link
Contributor

@LasseRosenow LasseRosenow commented Sep 23, 2025 •
edited
Loading

Contribution description

Added the changelog of riot releases to the guide page and deprecated the doxygen page

Nice cool new fetures:

  • Changelog is rendered and not in pure markdown anymore
  • Changelog page has a list of all releases and you can click to see the changelog of a single release
  • WE HAVE AN RSS FEED NOW!!!!!!111!!!111!!111
  • I also enabled emojis for the markdown parsing, since I was already playing around with markdown rendering and stuff

Screenshots

image image

@github-actions github-actions bot added the Area: doc Area: Documentation label Sep 23, 2025
@AnnsAnns
Copy link
Contributor

Huge W, Starlight giving us a really nice Changelog Reader + RSS Feed wasn't on my bingo card but I'm here for it :D

AnnsAnns
AnnsAnns reviewed Sep 23, 2025
View reviewed changes
Copy link
Contributor

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very cool 👍

@crasbe crasbe added Type: new feature The issue requests / The PR implemements a new feature for RIOT CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Sep 23, 2025
@riot-ci
Copy link

riot-ci commented Sep 23, 2025 •
edited
Loading

Murdock results

✔️ PASSED

44d9d3e fixup! doc/starlight: add changelog

Success Failures Total Runtime
1 0 1 01m:47s

Artifacts

@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch from 53956ae to b4d239d Compare September 24, 2025 06:19
@AnnsAnns AnnsAnns mentioned this pull request Sep 24, 2025
Draft
@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch 2 times, most recently from 81368aa to 16853f8 Compare September 24, 2025 11:12
@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch 2 times, most recently from d4dadcf to 3e36792 Compare September 24, 2025 11:19
AnnsAnns
AnnsAnns reviewed Sep 24, 2025
View reviewed changes
AnnsAnns
AnnsAnns reviewed Sep 24, 2025
View reviewed changes
AnnsAnns
AnnsAnns reviewed Sep 24, 2025
View reviewed changes
AnnsAnns
AnnsAnns suggested changes Sep 24, 2025
View reviewed changes
Copy link
Contributor

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤓☝️ A few more suggestions, but nice work on the loader, very elegant

@miri64
Copy link
Member

miri64 commented Sep 24, 2025

Known issues

* The headlines are not in the overview. this is caused by our release-notes using h1 level headings all over the place, even though a markdown file should only have one at the top.

I think with the Doxygen version of that I just added a regex, that bumped down all headers one level as a pre-filter.

@miri64
Copy link
Member

miri64 commented Sep 24, 2025

Ok, must have been a different script (just took a look at generate-changelog.py). But that would be a way to solve it.

AnnsAnns
AnnsAnns suggested changes Sep 24, 2025
View reviewed changes
Copy link
Contributor

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐸 One More Time

AnnsAnns
AnnsAnns approved these changes Sep 24, 2025
View reviewed changes
Copy link
Contributor

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🉑 🤠

crasbe
crasbe reviewed Sep 24, 2025
View reviewed changes
crasbe
crasbe reviewed Sep 25, 2025
View reviewed changes
Copy link
Contributor

@crasbe crasbe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you :)

@LasseRosenow
Copy link
Contributor Author

Ready for review :)

@LasseRosenow
Copy link
Contributor Author

Okay a small fix to the comments, but now it is ready

@LasseRosenow
Copy link
Contributor Author

There was a small mistake after my rewrite of the content collection generation yesterday, which resulted in the latest changelog not being visible. This is fixed now.
I hope there should be no more bugs anymore now :O

@LasseRosenow
Copy link
Contributor Author

LasseRosenow commented Sep 26, 2025 •
edited
Loading

I added a schema to improve type safety.
Can I squash?

crasbe
crasbe reviewed Sep 26, 2025
View reviewed changes
miri64
miri64 requested changes Sep 26, 2025
View reviewed changes
doc/starlight/src/content.config.ts Outdated
Comment on lines 46 to 50
// Convert all headings to be one level lower
// h1 => h2, h2 => h3, h3 => h4
// This is necessary, because the heading levels of this file are wrong (for markdown)
// We cannot have more than one h1 per document etc.
// Check if next line contains only "=" characters
Copy link
Member

@miri64 miri64 Sep 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there maybe be a general s/^(#)+/#\1/g (regex substitution for “add a # before every line that starts with a #”) before all this in case future release notes include deeper nesting than h3? (also I don't see any h4/#### in the current code which would also be covered by this)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes true so a better solution is to first convert the heading style to # based headings and then in general increase each # heading by one level?

This way we will also be compatible with higher heading nesting in the future and will also support converting # headings.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@crasbe crasbe crasbe left review comments

@miri64 miri64 miri64 requested changes

@aabadie aabadie Awaiting requested review from aabadie aabadie is a code owner

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

+1 more reviewer

@AnnsAnns AnnsAnns AnnsAnns approved these changes

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: new feature The issue requests / The PR implemements a new feature for RIOT
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@LasseRosenow @AnnsAnns @riot-ci @miri64 @crasbe