[STAR-2263] Providence: Initial Documentation
This Merge request creates the initial documentation for Providence.
JIRA tickets: https://tasks.opencraft.com/browse/STAR-2263
Dependencies: None
Sandbox URL: https://eye-of-providence.readthedocs.io/en/fox-star-2263-initial-documentation/
Testing instructions:
- Install
typedoc
in your path (for instance, withsudo npm install -g typedoc
npm install
- cd into the docs directory
make install_prereqs
make html
Also check the pipelines and the sandbox for the output.
Author notes and concerns:
The documentation should be (mostly) accurate when it comes to concepts and APIs. However, it's become apparent that the actual code usage is difficult to be sure of until packaging is finished, which has been slated for a follow-up task. So, I'd not recommend actually trying to install the package and use it to verify the documentation is 100% accurate (that can be done in the follow-up task) but verify that the documentation covers everything that it should and that the build for it works.