On Fri, May 28, 2021 at 12:16 PM Sebastien Lorquet <sebast...@lorquet.fr> wrote:
> The documentation about NuttX is exploded all around. This is an issue
> that is often noticed by all of my colleagues that attempted to have a
> look at this project.

Documentation has moved from place to place over the years, but we are
gradually consolidating it in the Documentation directory, which is
included in release artifacts and also appears on the website. AFAIK
the CWIKI is basically deprecated since having docs in the git repo
make it easier for anyone to contribute PRs, as opposed to needing an
account for the CWIKI. Also, that keeps the docs together with the
code so we don't have to worry about things like a future migration to
a different wiki or something like that. (Not saying that's gonna
happen; just saying we don't have to worry about the possibility of
it.) But there might still be things on the CWIKI or other older
locations that aren't in Documentation yet. If you find something like
that, please do let us know, or just send a PR.

I will say that much documentation exists in the form of people's
personal blogs, which are not part of this project. That is a
testament to this project's success. Compare Linux, which has
documentation on millions of websites.

I do think it would be helpful for ReleaseNotes (in the form of
separate files per releases) to be in Documentation/ReleaseNotes and
be made accessible from the Documentation page of the website
(http://nuttx.apache.org/docs/latest/) in case someone is looking for
them there; the same files should be accessible from the Releases page
where they are now, as Brennan enlightened me earlier.

Nathan

Reply via email to