Our public API documentation.
Most of the docs are generated via a script. The only thing that needs to be hand-written and hand-updated are the unified.yaml
files and anything in the /crm
or /home
directory.
Everything else should be generated by running:
cd scripts; yarn build-docs
After you run the generation you might need to clean up the files a bit since there are some known issues that the generation can get stuck on:
mint.json
might be ordered incorrectly, make sure everything abides by theorder
property*.yamls
might have garbage in theirexamples