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

Add API docs #316

Merged
merged 11 commits into from
Dec 8, 2023
Merged

Add API docs #316

merged 11 commits into from
Dec 8, 2023

Conversation

davidkpiano
Copy link
Member

@davidkpiano davidkpiano commented Dec 7, 2023 •
edited
Loading

Supersedes #288

cc. @audionerd

@vercel Vercel
Copy link

vercel bot commented Dec 7, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Dec 8, 2023 7:50am

davidkpiano
davidkpiano commented Dec 7, 2023
View reviewed changes
package.json Outdated Show resolved Hide resolved
mellson
mellson approved these changes Dec 8, 2023
View reviewed changes
Copy link
Member

@mellson mellson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great addition!

We should consider versioning the API docs at some point. Firstly, because it would be nice; secondly, because the API page is currently broken if you select XState v4 and try to open it. But that shouldn't hold back this PR.

@davidkpiano davidkpiano merged commit 91a8da3 into main Dec 8, 2023
1 check passed
@davidkpiano davidkpiano deleted the davidkpiano/api-docs branch December 8, 2023 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mellson mellson mellson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@davidkpiano @mellson