On Sun, Mar 8, 2020 at 2:35 PM Nathan Hartman <hartman.nat...@gmail.com> wrote:
> Cool! Would it be possible to convert these to Confluence and make them > available directly on the official Apache NuttX site? No. You're welcome to do that if you want. But I think there's value in having this set of docs in source control. Having the docs in a wiki would make it very hard to synchronize a version of documentation with a particular software revision if we wanted to do that, making it hard to get accurate docs for a particular release. Note that many projects and programming languages keep their docs in source control for this reason. (Python <https://github.com/python/cpython/tree/master/Doc>, Rust <https://github.com/rust-lang/book>, Clang <https://github.com/llvm-mirror/clang/tree/master/docs>, etc.) So does the Zephyr RTOS project BTW (docs <https://docs.zephyrproject.org/latest/>, docs source <https://github.com/zephyrproject-rtos/zephyr/tree/master/doc>). There's a more practical reason for me too... I find it extremely hard to create good-looking, usable documentation in Confluence. I prefer to use a technical documentation markup language like RST. > (Making it available > for reading and editing, will allow the community to further improve and > gradually complete your notes.) > The book is open source and on Github, I'm taking pull requests. So people are welcome to collaborate that way! And the project can be forked there too. My suggestion would be to simply put a link from the wiki docs to this book. I can't do that because I tried to create a Apache Confluence account that had edit rights a few weeks ago, and failed. I tried to get tech support from Apache but no one could help me work it out. cheers adam -- Adam Feuer <a...@starcat.io>
