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

Use TS for documentation guides #43

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Conversation

domin-mnd
Copy link
Collaborator

@domin-mnd domin-mnd commented Oct 29, 2023

Resolves #25.

  • Add a bit of consistency for code examples by importing some missing functions.
  • Replace string events with its corresponding enum values.
  • Remove tsx/tsup from getting started (unnecessary for the documentation).
  • Update README.md to match the gif (should I?)

@domin-mnd domin-mnd self-assigned this Oct 29, 2023
@domin-mnd domin-mnd linked an issue Oct 29, 2023 that may be closed by this pull request
@itsMapleLeaf itsMapleLeaf changed the base branch from dev to main October 29, 2023 19:05
Copy link
Owner

@itsMapleLeaf itsMapleLeaf left a comment

Choose a reason for hiding this comment

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

Ooh, thanks for this!

I updated this to merge into main, since there's no corresponding unreleased code changes with this.

Also, I forgot to mention this last time, but it's generally better to create PRs from a branch other than main, otherwise history can get confused and it's hard to include individual changes. Just a note for the future!

Only one small nit here, otherwise it looks good 👍

@domin-mnd
Copy link
Collaborator Author

Removed useless comments and added the readme gif counter in manual tests & readme.md code example. Not sure if we need that + I have no idea how gif updates button order 🤷

Copy link
Owner

@itsMapleLeaf itsMapleLeaf left a comment

Choose a reason for hiding this comment

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

Just one more thing, and it should be good. Sorry about the slight delay!

README.md Outdated Show resolved Hide resolved
@itsMapleLeaf itsMapleLeaf merged commit b641885 into itsMapleLeaf:main Nov 1, 2023
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use TypeScript for code examples in docs
2 participants