Project documentation
Opened this issue · 0 comments
drnikki commented
The docs are currently written and managed in Sphinx. The docs include the questions themselves (since they are just text) along with a lot of other text. As we move the questions to primary storage within JSON, we'll need a documentation system that enables people to look at the questions without having to be able to read JSON.
Required features:
- It's important that we have human-readable and human-accessible ways for folks to look at the text of the questions and some rationales for why the questions look the way that they look.
- These ways should exist outside of just browsing the github repo. We have a domain name (open-demographics.com), and could also host the docs on a host (I can pay for this).
Things that would be helpful:
- suggestion of (new?) ways to manage documentation in code that's easy for folks to use. I'm not attached to Sphinx, but I do think some kind of markdown/structured text makes sense.
- suggestion of how we can use the evolving JSON format to display the question inside of a documentation page.