v01d commented on pull request #1501: URL: https://github.com/apache/incubator-nuttx/pull/1501#issuecomment-672289394
Today I managed to finish the "reference" and "components" section, which is mostly the contents of the user and porting guide. There are two big ones that require considerable work: NSH and NxWidgets. I also improved the overall structure which I believe is friendlier to navigate. You can have a look if you like: https://v01d.github.io/incubator-nuttx/docs/index.html For NSH it is mostly about the very long list of commands. I've been looking at the `apps/nshlib/README.txt` and it seems there a lot of commands documented there as well. I'm wondering what would be the reasonable approach, to finish migrating the NSH HTML as-is and consolidate documentation later (which might be a lot of wasted effort) or look into getting that into the docs directly. For NxWidgets it is simply a ver long document so there's no way around that. I'm hoping that with these two complete, this could be much closer to being mergeable. There might be a lot of things that could be improved but I would prefer to do that in separate PRs to avoid continuing to grow this one. Also, I'd really like if the remaining effort could be distributed with others that are willing to give a hand with this. The effort will mostly be about looking at the generated documentation side-by-side with the HTML and look for things that are missing or look off. I've also found many typos/glitches in the original docs, but as I was focused on the migration they might still exist in the migrated ones. Of course, there's also a lot of undocumented functions and even whole parts of NuttX. That will the much longer to complete, but hopefully can be managed over time with help from others. I can eventually create an issue to track all of these. I'm thinking that one way to wrap this PR would be to: 1) finalize the CI changes in this PR, 2) squash, 3) backport doc changes introducing recently 4) remove HTMLs from /Documentation As I understand, there's a separate copy of the HTML docs on the wiki right? If so, removing HTMLs should not harm the availability of current docs. I would keep those for some time until we feel confident they can be archived. @btashton do you already have an idea about how CI should work for this to be published on the site? We can leave that for a separate PR and only leave the sphinx build here as a check to catch errors/warnings. But for deploying to the website I'm not sure how it would work. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
