A new Documentation project has recently been started that will eventually replace the docs and information that are currently in several different places (odk site, wiki, mailing list archives, people's brains, etc.).
I've been hired by Nafundi to manage this new documentation project.
Here's a little bit of the current plan...
-
We will follow the Docs as Code philosophy
-
Docs will be written in restructured text, a lightweight markup language similar to markdown (Why aren't we using markdown?)
-
Docs output will be built using Sphinx, a static site generator specifically designed for complex documentation projects like this
-
Doc source files will live in a github repo
-
One unified set of docs for all the components of ODK
-
Over the next couple weeks I will have a more formal plan along with a "how to contribute" doc, which will be the first new docs published with the new doc platform.
-
We'll start moving over old docs that are still relevant, useful, and accurate. As we do this we'll find plenty of things to fix, rewrite, or remove.
-
Contributions and GH issues welcome.
Thanks.