Hi everyone, Please take a look at http://mynewt.incubator.apache.org <http://mynewt.incubator.apache.org/>. I’d like to get some feedback on the current thinking around docs.
The Home page covers the basics of the project, status, and documentation (including how people can contribute to documentation). The basic framework of the site can be seen on the navigation bar. As new features and capabilities are developed we will see the menu getting richer. For example, as modules (e.g. Hardware abstraction layer, file systems, BLE stack etc) are completed, content will be added under “Modules”. As another example, as commands are added to the newt tool, we will update the command list under “Newt Tool”. I would like to check with you whether this basic skeleton is understandable and whether any major section is missing. I would then like to proceed with adding more details to the structure e.g. creating more module files (empty for now), creating OS detail files (empty to start with) etc. Content is written in Markdown files. The documentation repository has two branches. The master branch contains all the basic markdown files under the “docs” directory. When contributors update content, they will be generating pull requests on this branch and modifying/creating new files in the appropriate chapter. The html files are statically generated from this branch every night and pushed to the asf-site branch. Right now it’s manual - and I am willing to do it every night. I would like to look into automating the doc build process and pushing content automatically every night. Do you think we can build on this basic system? One option is to get some help from professional web-site developers to spruce up the site in order to attract more members to the community. However, Mkdocs offers some customization of looks and style as well as build automation - so I am thinking we should be able to manage it in house. I am spending some time looking into the customization over the next few days. Looking forward to your comments, thanks, aditi
