Chillbox Documentation
Documentation of Chillbox in AsciiDoc format.
Writing documentation for any software project is challenging. It is just as important as the code the application or website is written in. I approached this project knowing that I did not want to focus on anything else besides writing the actual documentation. In fact I had no idea where I was going to host the generated static files when I started the project.
I eventually settled on automating the generation of HTML, and other static resources via some scripts that I've commonly used in other projects. It was then included as another isolated service in the massive.xyz website.
AsciiDoc files: chillbox docs, chillbox-server docs
I opted to structure the documentation of the Chillbox CLI following what I've learned from the Divio Documentation System.
Technology Stack
Summary
- Writing good documentation is a challenging but rewarding endeavor.