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.

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

Update API documentation with TypeScript examples #498

Open
javierbrea opened this issue May 21, 2024 · 0 comments
Open

Update API documentation with TypeScript examples #498

javierbrea opened this issue May 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone
5.0.0

Comments

@javierbrea
Copy link
Member

The JavaScript API section in the website documentation should be updated with examples in TypeScript. Some API methods has changed as well. This should be documented in the "Releases" section, and also instructions about how to migrate should be added.

Breaking changes in the API are detailed in the CHANGELOG.md files of each package in the "release" branch, but this should be reviewed carefully.
@javierbrea javierbrea added this to the 5.0.0 milestone May 21, 2024
@javierbrea javierbrea added the documentation Improvements or additions to documentation label May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
TypeScript migration
Status: Todo
Milestone
5.0.0
Development

No branches or pull requests
1 participant
@javierbrea