Re:How I Judge the Quality of Documentation in 30 Seconds (2...
by uvtc on Friday October 05, 2018 @10:45PM
(#18153211)
Given that GitLab/GitHub/etc (and, often, online package repositories) automatically display markdown files as rendered html, a directory of markdown files is a fine way to document your project. The docs can, at any point, optionally be processed into html that goes into a separate website (lots of folks have written tools for this. My own is [Rippledoc](https://gitlab.com/uvtc/rippledoc)).
Also, if the project is a library or framework with a public interface, you need both API docs generated from source, and prose docs.
Also, if the project is a library or framework with a public interface, you need both API docs generated from source, and prose docs.