-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add test to check that supported boards contain a doc.md file #22224
Copy link
Copy link
Open
Labels
Area: docArea: DocumentationArea: DocumentationArea: testsArea: tests and testing frameworkArea: tests and testing frameworkCommunity: Hack'n'ACK candidateThis PR is a candidate for review and discussion during one of RIOT's monthly Hack'n'ACK partiesThis PR is a candidate for review and discussion during one of RIOT's monthly Hack'n'ACK partiesCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedCommunity: help wantedThe contributors require help from other members of the communityThe contributors require help from other members of the communityState: Pick me up plz 🥺This issue/PR is still relevant but won't be moved forward by the original author anymore,This issue/PR is still relevant but won't be moved forward by the original author anymore,Type: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Description
Metadata
Metadata
Assignees
Labels
Area: docArea: DocumentationArea: DocumentationArea: testsArea: tests and testing frameworkArea: tests and testing frameworkCommunity: Hack'n'ACK candidateThis PR is a candidate for review and discussion during one of RIOT's monthly Hack'n'ACK partiesThis PR is a candidate for review and discussion during one of RIOT's monthly Hack'n'ACK partiesCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedCommunity: help wantedThe contributors require help from other members of the communityThe contributors require help from other members of the communityState: Pick me up plz 🥺This issue/PR is still relevant but won't be moved forward by the original author anymore,This issue/PR is still relevant but won't be moved forward by the original author anymore,Type: enhancementThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentationThe issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
We should have a test, that requires boards to have a doc.md file.
No documentation => No support! :)
We also should mention in our documentation, that doc.md files are mandatory.