On Tue, Apr 25, 2023 at 8:14 PM Gregory Nutt wrote:
> Tomasz Cedro now owns nuttx.com and nuttx.org.

Yes the domains are for the project use, just let me know how you want
them configured, at this point they redirect to the main project site
:-)

I was thinking about maybe some showcases of the projects and products
made with NuttX at nuttx.com? That could present solid real world
applications and gather more interest around the project?


> One use of nuttx.org
> might be to use it to provide such a open, collaborative Wiki.  A
> gitbook might be better option.

Whatever tool works best :-) If we have online html access and can
perform some automation to gather everything we need in a single PDF
then its also cool :-) I must admit I have no experience with GitBook
o_O

The question remains on the tools selection (what platform to use),
integration with the source tree (if necessary), administration,
updates, backups, and moderation.. maybe GitHub is not that bad as
there is already some sort of users filtering, content moderation /
review / approval, integration of the documentation with the source
code, automation with CI, and no administration problems.

Documentation stored in a git repository along with the source code
may produce higher quality results and its seems a common approach.
Forums and wikis are good to talk, but they tend to get outdated
fast.. and gets lots of spam bots, shitstorms, and other things that
are not really on point with the project. Also it would distract
communications from the mailing list. Central points are good to keep
things coherent and in-sync.

But if the GitBook is verified Free and Open-Source tool that would
allow easier and faster editing, export to html and pdf, then why not?

Is it possible to create a dedicated github repository that could host
GitBook files and provide a frontend at given URL?

Was this considered before? :-)


>  Apparently Brennan Ashton created on
> https://cwiki.apache.org/confluence/display/NUTTX/Nuttxbook but the
> links there all get 404 error.

I could not find that project by GitLab search engine either. This is
the biggest danger of "external" resources they tend to disappear at
some point. This is probably the reason why current documentation is
kept with the source code in one place..?


--
CeDeROM, SQ7MHZ, http://www.tomek.cedro.info

Reply via email to