Description
Description
Note: moved from cypress-io/cypress-documentation#5039
We are working on a public API for third party CT framework definitions. Useful related issues:
- Epic: Support Public API for Third Party Component Testing Integrations #25637
- Implementation: feat: Public API for CT Framework Definitions #25780
- Tech Brief: https://github.com/cypress-io/engineering-documentation/tree/main/tech-briefs/ct-public-api
This issue is for tracking documentation relating to this. The CT team will take responsibility for writing the docs.
Acceptable Criteria
The documentation should include:
- Explain how to build a third party integration (guidelines, what is required, why, how it will show up in Cypress)
- Link to a template to make it easy for developers to follow the guidelines
- Any known caveats/recommendations
- A section that showcases known third party definitions (can be empty for now - add a CTA, like "Want to share an integration? Make a PR!)
- This entire thing can be 1 single page. It probably should go under the Component Testing header in the docs. You can sync with @elylucas if you are not sure where it should go or need more documentation-specific tips. He should also b e added as a reviewer on this PR.
Additional Information
Some examples that might be useful when documenting the feature:
- solid.js https://github.com/lmiller1990/cypress-ct-solid-js by @lmiller1990
- preact https://github.com/astone123/cypress-ct-test-preact by @astone123
Note: neither of these are production ready (no tests, no docs, probably have bugs) but they serve as examples on a minimal implementation, which I think is fine for documentation purposes. Once we have more fully fledged third party integrations, we can include those as good examples.
Metadata
Metadata
Assignees
Labels
No labels