docs: update user-event references #1030
Conversation
|
Note: The > bug fixes and new features. You can find the docs for `[email protected]`
> [here](../ecosystem-user-event.mdx).
becomes
> bug fixes and new features. You can find the docs for `[email protected]` >
> [here](../ecosystem-user-event.mdx). |
| render(<Checkbox />) | ||
| const user = userEvent.setup() | ||
|
|
||
| // You can also call this method directly on userEvent, |
There was a problem hiding this comment.
I'm not sure if that's even something we want to "share". If we believe that the recommended approach is to use the methods returned from setup, maybe this comment isn't helpful and can only cause bad practices. Wdyt?
There was a problem hiding this comment.
I think it eases the transition for people who are used to the previous APIs. That's why the Direct APIs still exist.
If there is only a single API call, it makes no difference, as the Direct APIs call .setup() internally and then use the method from there.
If it helps or hurts to mention it in the example - I don't know.
But I thought maybe mentioning it makes it sound "easier" to use.
I think I skipped I'm not sure I like what prettier does to the Markdown files. A lot of lines are much harder to comprehend with the line breaks at fixed width instead of at the end of subclauses. |
|
Are the old links properly redirecting? For example, if an external site linked to a user-event page, will that link continue to work or return a 404? |
|
Good point. For now the old page isn't removed. Later I would remove it from the navigation, but keep the page itself as long as there is a significant number of downloads for v13. |
docs/ecosystem-user-event.mdx
Outdated
| > This page describes `[email protected]`. | ||
| If you are starting or actively working on a project, | ||
| we recommend to use [`[email protected]`](user-event/intro.mdx) instead, as it includes important bug fixes and new features. | ||
| > This page describes `[email protected]`. |
There was a problem hiding this comment.
What do you think of making this a warning https://docusaurus.io/docs/markdown-features/admonitions?
To me, this doesn't stand out and could be overlooked.
There was a problem hiding this comment.
I converted those blockquotes on the intro into admonitions. :)
|
v14 has been released 🚀 |
Update all references to
user-eventpreparing for the upcoming release.This should be merged once the version is released on
latest:user-event@14has been released.