New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Set up basic documentation generation flow #6

Merged

achou11 merged 1 commit into main from ac/docs-generation

Dec 12, 2024

Member

achou11 commented Dec 11, 2024

Initial attempt at setting up tooling to generate docs based on TS + JSDoc annotations.

Currently uses https://github.com/peterpeterparker/tsdoc-markdown/ to output a single file at docs/API.md. The result is pretty barebones but probably sufficient for our needs.

Remaining tasks (many of which will probably be follow-ups):

Improve examples
Annotate other public APIs (mostly the lib/react-query stuff)
Set up a CI workflow to build docs on PRs


          Set up basic documentation generation flow

4107bba

achou11 merged commit d817d84 into main

3 checks passed

achou11 deleted the ac/docs-generation branch

December 12, 2024 17:09

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet