Removed the "Import and Export Test Cases" page from the docs #576
Conversation
Updated all the screenshots and GIFs in the "Projects and Settings" section according to the new UI.
…ments page Updated screenshots in the Collaboration section and revamped Requirements page according to the new UI.
Removed the "Import and Export Test Cases" page from the docs as per Biren's request.
WalkthroughThis pull request involves comprehensive documentation updates across multiple markdown files in the documentation section. The changes primarily focus on consistent terminology, capitalization, and image references. Key modifications include replacing the term "prompt" with "dialog", standardizing capitalization of terms like "Project" and "User Roles", and updating image references to match the revised content. The updates span various documentation pages related to collaboration, projects, test cases, and settings, ensuring a uniform and clear documentation style. Changes
Possibly related PRs
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
src/pages/docs/collaboration/assign-projects.md (1)
54-54: Add the missing article "the".For better readability and grammatical correctness, add "the" before "Add new user dialog".
-3. On **Add new user** dialog, enter **Email**, check **projects** you want to assign and **roles** corresponding to projects. +3. On the **Add new user** dialog, enter **Email**, check **projects** you want to assign and **roles** corresponding to projects.🧰 Tools
🪛 LanguageTool
[uncategorized] ~54-~54: You might be missing the article “the” here.
Context: ...New_Users_to_a_Project_2.1.png) 3. On Add new user dialog, enter Email,...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
src/pages/docs/projects/requirements.md (1)
51-51: Fix bullet point style for consistency.Use asterisk (*) instead of dash (-) for bullet points to maintain consistency with other bullet points in the document.
-Before you begin, ensure that you are familiar with concepts of [Create Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and [Requirement Type](https://testsigma.com/docs/projects/settings/requirement-types/). +* Before you begin, ensure that you are familiar with concepts of [Create Test Case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/) and [Requirement Type](https://testsigma.com/docs/projects/settings/requirement-types/).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
51-51: Unordered list style
Expected: asterisk; Actual: dash(MD004, ul-style)
src/pages/docs/projects/settings/test-case-types.md (1)
104-105: Fix spelling consistency: "dropdown" vs "drop down".Use consistent spelling for "dropdown" throughout the documentation.
-On **Manage Test Case** overlay, scroll down to **Test Type** and select test case type from the drop down menu. +On **Manage Test Case** overlay, scroll down to **Test Type** and select test case type from the dropdown menu.🧰 Tools
🪛 LanguageTool
[uncategorized] ~104-~104: The noun “dropdown” is spelled as one word.
Context: ...pe** and select test case type from the drop down menu. 
src/pages/docs/collaboration/invite-team-members.md (1)
49-49: Add missing article "the".Add the article "the" before "Invite new member dialog" for proper grammar.
-3. On **Invite new member** dialog, enter **Email** and select the **Role** you want to assign. +3. On the **Invite new member** dialog, enter **Email** and select the **Role** you want to assign.🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: You might be missing the article “the” here.
Context: ...embers_to_a_Project_Step_2.png) 3. On Invite new member dialog, enter **Ema...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
src/pages/docs/projects/versions.md (1)
97-97: Remove duplicate word in dialog title.The word "Delete" is repeated in the dialog title.
-4. On **Delete Delete Version?** dialog, enter **DELETE** and click on **I understand, delete this**. +4. On **Delete Version?** dialog, enter **DELETE** and click on **I understand, delete this**.🧰 Tools
🪛 LanguageTool
[duplication] ~97-~97: Possible typo: you repeated a word.
Context: .../applications/verdeclick.png) 4. On Delete Delete Version? dialog, enter DELETE and...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
src/pages/docs/collaboration/assign-projects.md(3 hunks)src/pages/docs/collaboration/elements-review-management.md(3 hunks)src/pages/docs/collaboration/invite-team-members.md(2 hunks)src/pages/docs/collaboration/manage-execution-stops.md(1 hunks)src/pages/docs/collaboration/users-roles.md(2 hunks)src/pages/docs/projects/applications.md(2 hunks)src/pages/docs/projects/overview.md(2 hunks)src/pages/docs/projects/requirements.md(1 hunks)src/pages/docs/projects/settings/requirement-types.md(3 hunks)src/pages/docs/projects/settings/test-case-types.md(4 hunks)src/pages/docs/projects/versions.md(3 hunks)src/pages/docs/test-cases/manage/import-export.md(0 hunks)src/pages/docs/test-cases/step-types/overview.md(1 hunks)
💤 Files with no reviewable changes (1)
- src/pages/docs/test-cases/manage/import-export.md
✅ Files skipped from review due to trivial changes (3)
- src/pages/docs/collaboration/manage-execution-stops.md
- src/pages/docs/projects/settings/requirement-types.md
- src/pages/docs/projects/overview.md
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/collaboration/assign-projects.md
[uncategorized] ~54-~54: You might be missing the article “the” here.
Context: ...New_Users_to_a_Project_2.1.png) 3. On Add new user dialog, enter Email,...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
src/pages/docs/projects/settings/test-case-types.md
[uncategorized] ~104-~104: The noun “dropdown” is spelled as one word.
Context: ...pe** and select test case type from the drop down menu. 
src/pages/docs/collaboration/invite-team-members.md
[uncategorized] ~49-~49: You might be missing the article “the” here.
Context: ...embers_to_a_Project_Step_2.png) 3. On Invite new member dialog, enter **Ema...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
src/pages/docs/projects/versions.md
[duplication] ~97-~97: Possible typo: you repeated a word.
Context: .../applications/verdeclick.png) 4. On Delete Delete Version? dialog, enter DELETE and...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
src/pages/docs/projects/settings/test-case-types.md
107-107: Heading style
Expected: atx; Actual: setext
(MD003, heading-style)
src/pages/docs/test-cases/step-types/overview.md
50-50: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
52-52: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
src/pages/docs/projects/requirements.md
49-49: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
51-51: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
56-56: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
85-85: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
97-97: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
106-106: No space after hash on atx style heading
null
(MD018, no-missing-space-atx)
🔇 Additional comments (5)
src/pages/docs/projects/applications.md (1)
46-46: LGTM!The terminology updates are consistent with the UI and documentation style guide.
Also applies to: 50-50
src/pages/docs/collaboration/elements-review-management.md (1)
37-37: LGTM!The terminology updates and capitalization changes are consistent with the documentation style guide.
Also applies to: 60-60, 64-64
src/pages/docs/collaboration/users-roles.md (1)
58-58: LGTM!The terminology updates from "prompt" to "dialog" are consistent across the documentation.
Also applies to: 73-73, 102-102
src/pages/docs/projects/requirements.md (1)
30-44: LGTM! Great addition of IEEE standard definition.The added content about IEEE standard 729 and types of software requirements enhances the documentation's clarity and completeness.
src/pages/docs/projects/versions.md (1)
Line range hint
1-1: Verify PR objective alignment.The PR description states that the "Import and Export Test Cases" page should be removed, but the provided files don't show this removal. Please verify if:
- The correct files are included in the PR
- The PR description accurately reflects the intended changes
|
|
||
|
|
||
| 4. The user will be assigned the selected projects with the selected access roles. | ||
| 1. The user will be assigned the selected projects with the selected access roles. |
There was a problem hiding this comment.
Fix the step numbering.
The step number "1" appears to be incorrect as it follows step 3. This breaks the sequential flow of the instructions.
-1. The user will be assigned the selected projects with the selected access roles.
+4. The user will be assigned the selected projects with the selected access roles.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. The user will be assigned the selected projects with the selected access roles. | |
| 4. The user will be assigned the selected projects with the selected access roles. |
| [[info | **NOTE**:]] | ||
| | | ||
| | - You can edit the target feature and scenario by clicking on the **Edit** icon. This will open the **Select Location** dialog. | ||
| | ![]() |
There was a problem hiding this comment.
Add alt text for images in the note section.
The images are missing alt text, which is required for accessibility.
-| ![]()
+| ![Edit icon for selecting location]()
-| ![]()
+| ![Select Location dialog]()Also applies to: 52-52
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
50-50: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
Removed the "Import and Export Test Cases" page from the docs as per the ticket: https://testsigma.atlassian.net/browse/IDEA-2175
Summary by CodeRabbit