DRAFT: Studio AI docs #6278
Open
DRAFT: Studio AI docs #6278
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cypress-documentation
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress-documentation
|
| Branch Review |
studio-ai
|
| Run status |
|
| Run duration | 05m 10s |
| Commit |
|
| Committer | Jennifer Shehane |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
309
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
10.83%
|
|
|---|---|
|
Untested elements
|
2489
|
|
Tested elements
|
3
|
Accessibility
97.22%
|
|
|---|---|
|
Failed rules
|
1 critical
3 serious
4 moderate
0 minor
|
|
Failed elements
|
28
|
Comment on lines
+79
to
+98
| ## AI-Powered Recommendations | ||
|
|
||
| Cypress Studio AI enhances your test creation workflow by automatically analyzing your interactions and suggesting relevant assertions in real time. As you record actions, the AI appears in the Studio Panel with intelligent recommendations tailored to each step. | ||
|
|
||
| ### How AI Recommendations Work | ||
|
|
||
| 1. **Automatic Analysis**: As you interact with elements, the AI analyzes the context and element properties | ||
| 2. **Smart Suggestions**: Relevant assertions appear in the Studio Panel based on your actions | ||
| 3. **Accept or Reject**: Review each recommendation and choose to accept or reject it | ||
| 4. **Seamless Integration**: Accepted recommendations can be saved to your test file | ||
|
|
||
| ### Types of AI Recommendations | ||
|
|
||
| The AI Suggests assertions based on changes within your App after interactions occur. | ||
|
|
||
| - **Visibility checks**: Ensure elements are visible or hidden | ||
| - **Text validation**: Verify text content matches expectations | ||
| - **Form validation**: Check input values, selections, and form states | ||
| - **Element properties**: Validate attributes, classes, and other properties | ||
|
|
There was a problem hiding this comment.
The AI-Powered Recommendations section was added inside the existing How Cypress Studio Works section and at the same hierarchy level. Should this be moved ahead of the title of the How Cypress Studio Works section as a standalone section to describe what Studio AI is?
Then in the Add assertions section, should it explain the two ways of adding assertions (manual vs AI) and when to use each one?
| <ProductHeading product="app" /> | ||
|
|
||
| # Cypress Studio | ||
| # Cypress Studio AI |
There was a problem hiding this comment.
I did not know the entire product was going to get rebranded as "Cypress Studio AI". There are still several places in the document where it is still referenced as just "Cypress Studio"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close https://github.com/cypress-io/cypress-services/issues/11595