foundry-vtt-tidy-5e-sheets
foundry-vtt-tidy-5e-sheets copied to clipboard
documentation: API and hooks
This initial attempt at documentation of the Tidy 5e API will seek to provide a framework, whether manual or automated, to present hooks and their types, API calls and their types, and example usages and scenarios.
- [x] Work a few more module compatibility issues
- [x] Make some real low-tech docs directly in github wiki.
Stretch
- [x] Rearrange the code so that all API-related code is able to be isolated and fed through documentation generation.
- [x] Apply TsDoc
- [x] Generate documentation
- [x] Get a github action set up which can update github docs for the repo with the generated type documentation
- [x] ... ?
- [ ] Consolidate and document all hooks
- [ ] Consolidate and document all flags