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
chore: normalize CT adapter readme documents #24590
Conversation
Thanks for taking the time to open a PR!
|
@@ -2,7 +2,7 @@ | |||
|
|||
> **Note** this package is not meant to be used outside of cypress component testing. | |||
|
|||
This librares exports some shared types and utility functions designed to build adapters for components frameworks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I figured that we should leave this one since it contains info that isn't captured in the docs, and it's a little different from our other adapter packages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice, this is a much better way to go about this
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, I definitely prefer the minimal docs here, in favor of deferring to our official documentation.
User facing changelog
n/a
Additional details
We want the documentation related to our
mount
commands to exist at https://docs.cypress.io. If someone is viewing the documentation for our adapter packages that we publish to NPM, they should be redirected to the Cypress docs instead. This way we only have to maintain one set of documentation.Note that the links to the docs site here are the updated links in the
release-11.0.0
branch, so they won't work on the production docs site right now. We won't merge this until that branch gets released to the docs siteSteps to test
Not much to test, just look at the readme for each package and verify that they are consistent and that they contain what we want them to.
I linked a docs PR in the tasks checklist that removes references to these readme documents since they have minimal information in them now.
How has the user experience changed?
n/a
PR Tasks
cypress-documentation
? Remove CT adapter readme links cypress-documentation#4846type definitions
?