Skip to content

[STAR-2263] Providence: Initial Documentation

Fox Piacenti requested to merge fox/STAR-2263-initial-documentation into master

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:

  1. Install typedoc in your path (for instance, with sudo npm install -g typedoc
  2. npm install
  3. cd into the docs directory
  4. make install_prereqs
  5. 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.

Edited by Fox Piacenti

Merge request reports