Skip to content

doc: Add README & Update Starlight#22101

Open
AnnsAnns wants to merge 1 commit intoRIOT-OS:masterfrom
AnnsAnns:update_docs
Open

doc: Add README & Update Starlight#22101
AnnsAnns wants to merge 1 commit intoRIOT-OS:masterfrom
AnnsAnns:update_docs

Conversation

@AnnsAnns
Copy link
Member

Contribution description

This simply updates all the starlight dependencies. I also added a README to the doc folder to make it a bit easier for developers to find the contribution guide (esp. now that a lot of guides are on the site and the contribution guide might not be as noticeable anymore).

Testing procedure

make doc-starlight and look at the site.

Issues/PRs references

@github-actions github-actions bot added the Area: doc Area: Documentation label Feb 24, 2026
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / 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 labels Feb 24, 2026
@riot-ci
Copy link

riot-ci commented Feb 24, 2026

Murdock results

✔️ PASSED

4d0b093 doc: Add README & Update Starlight

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

Artifacts

doc/README.md Outdated

### Starlight / Guide Site

Starlight is the main documentation site for RIOT, located at [guide.riot-os.org](https://guide.riot-os.org/), the `starlight` directory itself mostly only holds the source files for the site, excluding most guides which are stored within `guides`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Long lines 👀

Copy link
Member Author

Choose a reason for hiding this comment

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

smol lines 👍

@AnnsAnns
Copy link
Member Author

After concerns from @LasseRosenow about a previous update breaking Starlight (one we intentionally never updated to because of that), I retested everything on both dev preview and prod preview and everything appears to be in order 👍

Copy link
Member

@LasseRosenow LasseRosenow left a comment

Choose a reason for hiding this comment

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

Thanks for checking that everything still works :)

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: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants