John Tucker addresses important question how to create documentation for open source project. He takes us through example and will demonstrate a compelling documentation organization for an open source project.
Author pieced together the project’s documentation organization. Documentation entry point is in 3 places:
- Web site of HTML pages (including a search feature) generated with GitBook
- README.md markup file in the root folder of the master branch
- README.md markup file in the docs folder of the master branch
The HTML pages are generated from source markup files from the master branch of the repository. Author also offered solution for automation of the documentation updates using Travis CI (via travis.yml configuration filke). You will also find code examples for this article in the GitHub repository together with explanation how to use GitHub Pages. Interesting.
[Read More]