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

Auto-generated API docs for JavaScript SDKs #11

Open
bajtos opened this issue Jan 30, 2023 · 0 comments
Open

Auto-generated API docs for JavaScript SDKs #11

bajtos opened this issue Jan 30, 2023 · 0 comments
Labels
feature New feature or request

Comments

@bajtos
Copy link
Member

bajtos commented Jan 30, 2023

When we add a new API to Zinnia, there should be an automated way how to update our JS API docs from code comments in jsdoc/tsdoc style.

Ideally, we should also provide TypeScript definition files describing our APIs, so that module authors can type-check their code.

@bajtos bajtos added this to the v0.3 - Content Retrieval Checker milestone Jan 31, 2023
@bajtos bajtos removed this from the v0.3 - Content Retrieval Checker milestone Feb 8, 2023
@bajtos bajtos added the feature New feature or request label Mar 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant