v3 overhaul #61
Merged
v3 overhaul #61
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
- Clarify usage of `url`, `origin`, and `statusCodes` in the action description. - Standardize examples to use `checkLink` as an object. - Update deprecated `setVariables` action to `loadVariables`.
- Clarify the description of the `find` action. - Add detailed properties for the object format, including `click`. - Provide multiple examples demonstrating various use cases for the `find` action.
- Clarify the description of the `find` action to include CSS/XPath selector. - Specify that the element must match both `elementText` and `selector` when used together. - Update example descriptions to reflect the use of CSS selectors. - Add a new example for finding an element and middle-clicking it.
- Clarify the description of the `goTo` action. - Add details on specifying the target URL as a string or object. - Include examples for using the `goTo` action with different formats.
- Clarify usage of the `runShell` action and its command execution context. - Expand options for command specification, including arguments and working directory. - Update examples to reflect new object format for commands. - Improve descriptions for expected output validation and exit code handling. - Revise variable setting instructions for better clarity.
- Introduce `runCode` action to execute code snippets in various languages. - Specify required and optional properties for the action. - Provide examples for using the action with Python, JavaScript, and Bash.
- Clarify the description and usage of the `httpRequest` action. - Add detailed options for request and response configurations. - Include examples for various request types (GET, POST, PUT) and OpenAPI usage. - Provide instructions for setting variables from response bodies and saving responses to files.
- Add details on setting variables to capture element attributes for later steps.
- Create a new documentation file for the `screenshot` action. - Describe the functionality, options, and examples for taking screenshots. - Include details on visual regression testing and cropping options.
- Create a new documentation file for the `loadVariables` action. - Describe the purpose and usage of loading environment variables from a `.env` file. - Provide an example of how to use the `loadVariables` action in a test. - Remove the outdated `setVariables` documentation file.
- Create `record.md` to document the recording action and its usage. - Remove outdated `startRecording.md` documentation. - Create `stopRecord.md` to document the stopping action and its usage. - Remove outdated `stopRecording.md` documentation.
- Introduce `type` action to simulate key presses, including special keys. - Provide detailed instructions on specifying keys using string, array, and object formats. - Include a comprehensive list of special keys and their codes. - Add examples demonstrating the usage of the `type` action in various scenarios. - Remove outdated `typeKeys` documentation.
- Clarify the purpose of the `wait` action and its usage. - Update examples to reflect the correct structure and default duration. - Remove outdated descriptions and ensure consistency in example formatting.
- Clarify steps and actions in the test specification section. - Add new actions: `click`, `loadVariables`, `record`, `stopRecord`, and `screenshot`. - Update action references in examples to reflect new naming conventions. - Improve inline JSON examples for better clarity.
- Remove deprecated "runTests" property. - Update "Click" action to use "find" object. - Change "saveScreenshot" action to use "screenshot" object.
- Replace old action names with updated ones - Modify descriptions for clarity - Ensure consistency in action terminology
- Remove unnecessary braces in JSON examples - Update action descriptions for clarity - Standardize formatting of JSON snippets - Improve inline instructions for better readability
- Add 'click' action to the Actions category - Replace 'saveScreenshot', 'setVariables', 'startRecording', 'stopRecording', and 'typeKeys' with 'screenshot', 'loadVariables', 'record', 'stopRecord', and 'type'
- Bump version of doc-detective-common to ^3.0.1 - Update dotenv to ^16.5.0 - Upgrade react and react-dom to ^19.1.0
- Update action keys in the test JSON structure for consistency. - Modify descriptions to better reflect the actions being performed. - Change output format for the test results to enhance readability.
- Change "Boolean Shorthand" to "String Shorthand" for consistency. - Clarify the description of the click action's properties. - Update examples to reflect correct usage of the click action.
- Bump version of doc-detective-common to 3.0.2 - Update dotenv to version 16.5.0 - Upgrade react and react-dom to version 19.1.0 - Update scheduler to version 0.26.0
- Clarify the options for the click field to include references to detailed schemas.
…e correct schema. - Modify `fileTypes` description in config schema for clarity. - Adjust `httpRequest` type definition for consistency. - Add new `type` schema documentation with detailed examples.
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Doc Detective' |
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.
No description provided.