wonderchook/docs

Open Data Kit Documentation, built in Sphinx.

ODK Docs

This repo is the source for ODK documentation.

Current Status — Live! (But still new)

Our documentation website is live at https://docs.opendatakit.org

If you can't find what you are looking for, try the old docs on the ODK website. Also, please file an issue so that we know to add the information you are looking for.

Building and viewing documentation locally

See the Contributor Guide for detailed steps --- no prior experience needed!

Once your environment is set up:

sphinx-build -b dirhtml . build
cd build
python -m http.server 8000

How to contribute?

We are open for new issues and pull requests.

• Please read the Contributors Guide before working on the documentation.
• Find issues to work on.
  • First time contributors are encouraged to complete a line edit as a way to get familiar with our contribution process.
  • Issues labelled easy do not require much specific technical knowledge.
  • Issues labelled contributor friendly are usually self-contained and don't require extensive knowledge of the ODK ecosystem as a whole.

You can also...

• Discuss the documentation from a user perspective in our forum.
• Discuss the documentation from a contributor perspective in our developer Slack. (Use the #docs-code channel.)
• File an issue for any needed improvements.
• Watch and star this repo, to keep up with what we're doing.