Skip to content

doc/starlight: add RIOT changelog#21741

Merged
crasbe merged 2 commits intoRIOT-OS:masterfrom
LasseRosenow:guides-add-riot-changelog
Oct 2, 2025
Merged

doc/starlight: add RIOT changelog#21741
crasbe merged 2 commits intoRIOT-OS:masterfrom
LasseRosenow:guides-add-riot-changelog

Conversation

@LasseRosenow
Copy link
Copy Markdown
Member

@LasseRosenow LasseRosenow commented Sep 23, 2025

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
Copy Markdown
Member

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

Copy link
Copy Markdown
Member

@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
Copy Markdown

riot-ci commented Sep 23, 2025

Murdock results

✔️ PASSED

6d50318 doc/doxygen: deprecate changelog

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

Artifacts

Copy link
Copy Markdown
Member

@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
Copy Markdown
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
Copy Markdown
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.

Copy link
Copy Markdown
Member

@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

Copy link
Copy Markdown
Member

@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.

🉑 🤠

Copy link
Copy Markdown
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
Copy Markdown
Member Author

Ready for review :)

@LasseRosenow
Copy link
Copy Markdown
Member Author

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

@LasseRosenow
Copy link
Copy Markdown
Member 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
Copy Markdown
Member Author

LasseRosenow commented Sep 26, 2025

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

miri64
miri64 previously requested changes Sep 26, 2025
@LasseRosenow
Copy link
Copy Markdown
Member Author

I accidentally edited the vscode settings.json, I fixed that now and also added settings for javascript and typescript there.

Ready for review :)

@LasseRosenow LasseRosenow changed the title doc/guides: add riot changelog doc/starlight: add riot changelog Sep 29, 2025
Copy link
Copy Markdown
Member

@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.

Lasse asked me to quickly check again after the rewrite of the way he handles the parser but there is nothing that I can really complain about anymore that didn't feel like extreme nitpicking so uh, hope this gets merged thank you for this 🐸 🎉

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Oct 2, 2025

Please squash :)

@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch from e42bea3 to 06ce8c4 Compare October 2, 2025 12:18
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Oct 2, 2025

Please squash again :)
(There is one commit called Fix Changes. You could also rename it.)

@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch from 06ce8c4 to cdc6724 Compare October 2, 2025 12:20
@crasbe crasbe changed the title doc/starlight: add riot changelog doc/starlight: add RIOT changelog Oct 2, 2025
@LasseRosenow LasseRosenow force-pushed the guides-add-riot-changelog branch from cdc6724 to 6d50318 Compare October 2, 2025 12:54
@LasseRosenow
Copy link
Copy Markdown
Member Author

LasseRosenow commented Oct 2, 2025

(There is one commit called Fix Changes. You could also rename it.)

Yeah myself "git" created some problems. I have fixed it now. :)

Squashed squashed squassshhhhed :)

@crasbe crasbe added this pull request to the merge queue Oct 2, 2025
Merged via the queue into RIOT-OS:master with commit 0b436d8 Oct 2, 2025
25 checks passed
@LasseRosenow LasseRosenow deleted the guides-add-riot-changelog branch October 2, 2025 16:56
@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

Development

Successfully merging this pull request may close these issues.

6 participants