How-to contribute to documentation

[robwasab]

Hello,

I've never contributed to an open source project before, so I don't know who I should be directing these questions to.

I've been looking at the code for a while, particularly as much as possible, the waf build system and how the drivers work and how they are ported from one board to another or from one chip to another. Additionally, how the SDK for each chip platform is built and that it's compiled as library and that it's linked into the project.

I want to try my hand at writing documentation as I go through these systems, because it might add value to the project.

How should I go about doing this? I see that the documentation is now being centralized in a readthedocs.

I'm guessing that: I find the readthedocs repo, and then make the documentation additions and then submit a PR, then the project administrator would then approve it?

[WuerfelDev]

I find the readthedocs repo

It's right here in this repo in the /docs directory.
However the docs aren't built from source code comments yet. Not sure if that's the plan or not

[robwasab]

Duh. Thanks for point out the obvious.

[gmarull]

Documentation resides now in docs folder and it is built and hosted by rtd. You can contribute by opening a regular PR. Doxygen is currently not built.