Skip to content

boards: add missing doc.md files#22221

Merged
AnnsAnns merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:add_readmes_to_boards
May 5, 2026
Merged

boards: add missing doc.md files#22221
AnnsAnns merged 1 commit intoRIOT-OS:masterfrom
AnnsAnns:add_readmes_to_boards

Conversation

@AnnsAnns
Copy link
Copy Markdown
Member

@AnnsAnns AnnsAnns commented Apr 28, 2026

Contribution description

This is part of the #22203 fixes. It simply adds extremely rudimentary doc.md files just so we have something.

Testing procedure

Issues/PRs references

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

  • Copilot inline assist thingy

@AnnsAnns AnnsAnns requested review from dylad and jia200x as code owners April 28, 2026 13:32
@github-actions github-actions Bot added Area: doc Area: Documentation Area: boards Area: Board ports labels Apr 28, 2026
crasbe
crasbe reviewed Apr 28, 2026
View reviewed changes
Comment thread boards/bastwan/doc.md Outdated

## Overview

The BastWan is a development board featuring the Microchip SAMR34 series SoC with integrated LoRa radio. It is suitable for low-power IoT and LoRaWAN projects and includes the MCU and radio on a compact evaluation board.
Copy link
Copy Markdown
Contributor

@crasbe crasbe Apr 28, 2026

Choose a reason for hiding this comment

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

Long line bois, also in the other files.

Copy link
Copy Markdown
Member Author

@AnnsAnns AnnsAnns Apr 28, 2026

Choose a reason for hiding this comment

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

any% WR review holy

@AnnsAnns AnnsAnns 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 Apr 28, 2026
crasbe
crasbe reviewed Apr 28, 2026
View reviewed changes
Comment thread boards/hifive1/doc.md Outdated
Comment thread boards/hifive1b/doc.md Outdated
Comment thread boards/hifive1b/doc.md Outdated

## Overview

HiFive1 Revision B is an updated variant of the HiFive1 development board using a RISC-V FE310 series MCU with improvements in board configuration. It remains a compact platform for RISC-V development with RIOT-OS.
Copy link
Copy Markdown
Contributor

@crasbe crasbe Apr 28, 2026

Choose a reason for hiding this comment

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

Perhaps you can also add a link to the old revision?

Comment thread boards/hifive1/doc.md Outdated

## Overview

The HiFive1 is an open-source development board based on the SiFive FE310 RISC-V core. It is designed for RISC-V software and hardware experimentation and supports running RIOT-OS on a RISC-V platform.
Copy link
Copy Markdown
Contributor

@crasbe crasbe Apr 28, 2026

Choose a reason for hiding this comment

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

Perhaps you can also add a link to the new revision?

Something like "Click here for Revision B".

Comment thread boards/samr30-xpro/doc.md Outdated
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Apr 28, 2026
@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Apr 28, 2026

Oh no, you touched the wrong files 👀

image

@AnnsAnns
Copy link
Copy Markdown
Member Author

AnnsAnns commented Apr 28, 2026

Oh no, you touched the wrong files 👀
image

😢 Curse you legacy code

@AnnsAnns AnnsAnns added the State: waiting for author State: Action by the author of the PR is required label Apr 28, 2026
@AnnsAnns
Copy link
Copy Markdown
Member Author

AnnsAnns commented Apr 28, 2026

I'll turn this into a draft for now since I don't really want to deal with getting legacy code up to standards with RIOT right now :P

@AnnsAnns AnnsAnns marked this pull request as draft April 28, 2026 13:53
@LasseRosenow
Copy link
Copy Markdown
Member

LasseRosenow commented Apr 28, 2026

Maybe also add a test, that requires new boards to have doc.md files from now on?

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Apr 28, 2026

I'll turn this into a draft for now since I don't really want to deal with getting legacy code up to standards with RIOT right now :P

my-disappointment (1)

@crasbe
Copy link
Copy Markdown
Contributor

crasbe commented Apr 28, 2026

Maybe also add a test, that requires new boards to have doc.md files from now on?

I like that idea, but perhaps it's best to open a separate issue for that?

While you're at it, you can write down in the issue to adapt the documentation to mention that the doc.md file is a requirement. I know that it has a file tree there and some explanation, but I'm not sure if it already states that the doc.md is mandatory.

@riot-ci
Copy link
Copy Markdown

riot-ci commented Apr 28, 2026 •
edited
Loading

Murdock results

✔️ PASSED

c55ab89 boards: add doc.md for multiple boards missing documentation

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

Artifacts

@AnnsAnns AnnsAnns force-pushed the add_readmes_to_boards branch from 9cbf984 to e06f213 Compare April 29, 2026 09:52
@LasseRosenow LasseRosenow mentioned this pull request May 4, 2026
Closed
@zhqqzn zhqqzn mentioned this pull request May 5, 2026
Merged
@crasbe crasbe marked this pull request as ready for review May 5, 2026 13:29
crasbe
crasbe previously approved these changes May 5, 2026
View reviewed changes
@crasbe crasbe dismissed their stale review May 5, 2026 13:38

Too quickly.

crasbe
crasbe approved these changes May 5, 2026
View reviewed changes
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.

Ah, long lines addressed. Now we're good :)

@crasbe crasbe removed the State: waiting for author State: Action by the author of the PR is required label May 5, 2026
@AnnsAnns @crasbe
boards: add doc.md for multiple boards missing documentation
c55ab89 
boards: remove duplicate doc group declarations

boards/bastwan: fix doxygen errors

boards/ublox-c030-u201: fix doxygen errors

Co-authored-by: crasbe <crasbe@gmail.com>
@AnnsAnns AnnsAnns force-pushed the add_readmes_to_boards branch from 5e094e5 to c55ab89 Compare May 5, 2026 13:41
@AnnsAnns
Copy link
Copy Markdown
Member Author

AnnsAnns commented May 5, 2026

I feel like I should be allowed to also approve this PR now 😛

@AnnsAnns AnnsAnns enabled auto-merge May 5, 2026 13:42
@crasbe crasbe mentioned this pull request May 5, 2026
Open
7 tasks
@AnnsAnns AnnsAnns added this pull request to the merge queue May 5, 2026
Merged via the queue into RIOT-OS:master with commit e699b87 May 5, 2026
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@crasbe crasbe crasbe approved these changes

@maribu maribu maribu approved these changes

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

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

+1 more reviewer

@LasseRosenow LasseRosenow LasseRosenow left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Area: boards Area: Board ports 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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@AnnsAnns @crasbe @LasseRosenow @riot-ci @maribu