Skip to content
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.

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

Automated documentation updates #59

Open
osdiab opened this issue Feb 1, 2021 · 1 comment
Open

Automated documentation updates #59

osdiab opened this issue Feb 1, 2021 · 1 comment
Assignees

Comments

@osdiab
Copy link
Contributor

osdiab commented Feb 1, 2021

Would be nice to generate the options/examples automatically from source with something like JSDoc.

@osdiab
Copy link
Contributor Author

osdiab commented Feb 9, 2021

We can probably write TSDoc comments and then use microsoft's parser to parse them, dump them into the README (as opposed to something heavy-weight like using typedoc to generate an entire site). This library isn't that big, so just need to basically do the config object.

https://github.com/microsoft/tsdoc/tree/master/tsdoc

@osdiab osdiab added the p3 label Feb 10, 2021
@osdiab osdiab self-assigned this Feb 10, 2021
@osdiab osdiab added the tooling label Feb 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant