Re: Enhancing documentation

2025-05-16 Thread Matteo Golin
I've opened a draft PR here creating a standardized template for board documentation: https://github.com/apache/nuttx/pull/16405 Please take a look and leave your suggestions for what should be included in a board documentation page so that we can start using this template to enhance quality and

Re: Enhancing documentation

2025-05-09 Thread Matteo Golin
Yes, that makes perfect sense. Thanks for linking the issue! Wonder if we could game-ify some of these issues somehow, or make it more appealing to have docs written. I know guidelines for everything going forward requires docs to be included, but some way of motivating patches for existing gaps w

Re: Enhancing documentation

2025-05-09 Thread raiden00pl
Hi, issue with blank pages is already here: https://github.com/apache/nuttx/issues/11081 I haven't updated it for a long time, in fact I even forgot that I created it :) I agree with your diagnosis: better documentation means more contributors, and that's what NuttX needs. But the truth is that

Re: Enhancing documentation

2025-05-07 Thread Tomek CEDRO
Great work and Big Thank You Matteo! :-) Tomek On Wed, May 7, 2025 at 4:51 AM Matteo Golin wrote: > > Hello everyone, > > I just opened a PR here for migrating some of the README.txt files to RST > files (for board documentation, > https://github.com/apache/nuttx/pull/16328). This is part of the

Enhancing documentation

2025-05-06 Thread Matteo Golin
Hello everyone, I just opened a PR here for migrating some of the README.txt files to RST files (for board documentation, https://github.com/apache/nuttx/pull/16328). This is part of the long list of old README files that need to be migrated, all laid out in issue #11077 (https://github.com/apac