-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Open
Labels
Area: docArea: DocumentationArea: DocumentationCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedDiscussion: RFCThe issue/PR is used as a discussion starting point about the item of the issue/PRThe issue/PR is used as a discussion starting point about the item of the issue/PRState: don't staleState: Tell state-bot to ignore this issueState: Tell state-bot to ignore this issue
Description
I've come to realize that many new users struggle with what to include into their application and realized that while we have a good API documentation there is no specific information how to include a certain component. There is some general information about USEMODULE
in the doc, but no information about what to add to USEMODULE
if I want to include the e.g. net/gnrc/pktbuf.h
in your project.
My proposal is that the first section of each module API doc should name the module(s) required for the functionality.
This is a lot of work so before I start it I would like your opinion on that.
Metadata
Metadata
Labels
Area: docArea: DocumentationArea: DocumentationCommunity: good first issueThis issue is good for newcomers to RIOT to be addressed / implementedThis issue is good for newcomers to RIOT to be addressed / implementedDiscussion: RFCThe issue/PR is used as a discussion starting point about the item of the issue/PRThe issue/PR is used as a discussion starting point about the item of the issue/PRState: don't staleState: Tell state-bot to ignore this issueState: Tell state-bot to ignore this issue