Documentation How-To

Development archive
1

Hi, I came up with some “rules” about where to put what documentation: [1]. They represent an idea of how it could be, not how it currently is. Does anyone has any input on that.

Cheers, Martine

[1] https://github.com/RIOT-OS/RIOT/wiki/Documentation-101

2

Hi Martine!

I came up with some "rules" about where to put what documentation: [1]. They represent an idea of how it could be, not how it currently is. Does anyone has any input on that.

I'm still not convinced that we need any rules for that, but if it helps some people, why not. However, what is the title of this page is supposed to mean? It looks a bit confusing to me.

Cheers, Oleg

3

Hi Oleg,

4

Hi there,

I don’t know about 101 or no 101 (although maybe it’s too american centric an expression, indeed, so I’d vote for another title). But I do support some explicit policy as to how to contribute documentation to RIOT. The hope is that it will diminish duplicate documentation, and thus diminish outdated/conflicting/desynchronized documentation.

best,

Emmanuel