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

Initial docs for the project #6

Merged
merged 17 commits into from
Dec 14, 2021
Merged

Initial docs for the project #6

merged 17 commits into from
Dec 14, 2021

Conversation

crutchcorn
Copy link
Owner

This PR introduces early docs for the project. These docs, as I'm writing them, may influence the API - like it did when we introduced userEvent

Note that our docs are intended to align as closely with upstream's (Testing Library) as possible, while also providing docs like differences.md to quickstart devs that are already familiar with upstream.

Once these docs are completed, we'll be releasing v1 (with the understanding that pending feedback in #2 we may likely push a v2 soon after)

@crutchcorn crutchcorn changed the title Initial docs for the project [WIP] Initial docs for the project Dec 9, 2021
@crutchcorn crutchcorn changed the title [WIP] Initial docs for the project Initial docs for the project Dec 14, 2021
@crutchcorn crutchcorn merged commit d557c14 into alpha Dec 14, 2021
@crutchcorn crutchcorn deleted the alpha-docs branch December 14, 2021 05:21
@github-actions
Copy link

🎉 This PR is included in version 1.0.0-alpha.17 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant