Skip to content

doc/guides: Add Section about Creating a Common Board Directory#21764

Merged
crasbe merged 3 commits intoRIOT-OS:masterfrom
crasbe:pr/guides_common_boards
Oct 7, 2025
Merged

doc/guides: Add Section about Creating a Common Board Directory#21764
crasbe merged 3 commits intoRIOT-OS:masterfrom
crasbe:pr/guides_common_boards

Conversation

@crasbe
Copy link
Copy Markdown
Contributor

@crasbe crasbe commented Oct 7, 2025

Contribution description

As "discovered" in #21745, the common code process introduced in #21327 was not sufficiently documented yet.

Also in #21708, the documentation added in #21327 was removed for some reason, therefore I re-added it here.

Lastly, one of the Further Reference links was broken, that also got fixed.

Testing procedure

Run make doc-starlight and look at the documentation.

Issues/PRs references

Better document the new proecss introduced in #21327.

Re-add documentation errorneously removed in #21708.

@crasbe crasbe requested a review from AnnsAnns October 7, 2025 12:32
@crasbe crasbe requested a review from aabadie as a code owner October 7, 2025 12:32
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Oct 7, 2025
@crasbe crasbe requested a review from jia200x as a code owner October 7, 2025 12:32
@crasbe crasbe added 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 Oct 7, 2025
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 7, 2025
@crasbe
Copy link
Copy Markdown
Contributor Author

crasbe commented Oct 7, 2025

Starlight showed some errors about the language set for the Syntax Highlighting. I thought this was already fixed in the big migration, but apparently not 🤔

@crasbe crasbe force-pushed the pr/guides_common_boards branch from 6102bfb to a2faed7 Compare October 7, 2025 13:22
@crasbe
Copy link
Copy Markdown
Contributor Author

crasbe commented Oct 7, 2025

Starlight showed some errors about the language set for the Syntax Highlighting. I thought this was already fixed in the big migration, but apparently not 🤔

Nevermind, I added them myself 👀 😅

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 stuff ty

@riot-ci
Copy link
Copy Markdown

riot-ci commented Oct 7, 2025

Murdock results

✔️ PASSED

0d578f8 doc/guides/porting-boards: fix regression from #21708

Success Failures Total Runtime
1 0 1 02m:38s

Artifacts

@AnnsAnns
Copy link
Copy Markdown
Member

AnnsAnns commented Oct 7, 2025

this can be squashy squash squashed from my pov, ty :D

@crasbe crasbe force-pushed the pr/guides_common_boards branch from 96ba236 to d5cf371 Compare October 7, 2025 14:44
@crasbe crasbe force-pushed the pr/guides_common_boards branch from d5cf371 to 0d578f8 Compare October 7, 2025 14:46
@crasbe crasbe enabled auto-merge October 7, 2025 14:48
@crasbe crasbe added this pull request to the merge queue Oct 7, 2025
Merged via the queue into RIOT-OS:master with commit 7de0d1b Oct 7, 2025
25 checks passed
@crasbe crasbe deleted the pr/guides_common_boards branch October 7, 2025 14:55
@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: 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.

5 participants