Skip to content

CONTRIBUTING: update documentation section#22483

Open
AnnsAnns wants to merge 1 commit into
RIOT-OS:masterfrom
AnnsAnns:contributing_update
Open

CONTRIBUTING: update documentation section#22483
AnnsAnns wants to merge 1 commit into
RIOT-OS:masterfrom
AnnsAnns:contributing_update

Conversation

@AnnsAnns

Copy link
Copy Markdown
Member

Contribution description

@lukasseb noticed that the documentation section was heavily outdated (not only with the doc.txt stuff but like, doesn't reflect the reality whatsoever anymore).

Testing procedure

Issues/PRs references

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

  • it is still very loud in this room :(

@AnnsAnns
AnnsAnns requested a review from jia200x as a code owner July 18, 2026 16:27
@github-actions github-actions Bot added the Area: doc Area: Documentation label Jul 18, 2026
@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 AI: None Stated AI was not (stated to be) used in this PR/Issue labels Jul 18, 2026
@crasbe crasbe added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Jul 18, 2026
@crasbe

crasbe commented Jul 18, 2026

Copy link
Copy Markdown
Contributor

Perhaps you can shorten it even more and refer to the Coding Conventions? https://github.com/RIOT-OS/RIOT/blob/master/CODING_CONVENTIONS.md#documentation

OR move the stuff from the Coding Conventions to the Contributing page?

@crasbe
crasbe requested a review from miri64 July 18, 2026 17:27
@riot-ci

riot-ci commented Jul 18, 2026

Copy link
Copy Markdown

Murdock results

✔️ PASSED

0e72726 CONTRIBUTING: update documentation section

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

Artifacts

@LasseRosenow LasseRosenow left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice thank you

@crasbe crasbe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See comment above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI: None Stated AI was not (stated to be) used in this PR/Issue 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