Update multi tasks docs
#8516
Update multi tasks docs
#8516
Conversation
WalkthroughThe changes include updates to the Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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: 1
🧹 Outside diff range and nitpick comments (9)
cvat-ui/src/components/create-task-page/styles.scss (1)
42-44: LGTM! Consider adding a comment for clarity.The addition of the
.cvat-task-name-field-has-tooltipclass aligns well with the PR objective of adjusting UI styles. The use of$grid-unit-sizemaintains consistency with existing styling conventions.Consider adding a brief comment above the class to explain its purpose, for example:
// Adjust spacing for task name fields with tooltips .cvat-task-name-field-has-tooltip { margin-bottom: $grid-unit-size; }This would enhance code readability and maintainability.
site/content/en/docs/manual/basics/create-multi-tasks.md (2)
28-28: LGTM: Improved task configurator instructions.The updates enhance clarity and provide more accurate visual guidance. The simplification of task naming instructions is particularly helpful.
Consider adding a brief explanation of what the
{{index}}and{{file_name}}placeholders do, for example:- (Optional) `{{index}}` adds a sequential number to the task name (starting from 0). - (Optional) `{{file_name}}` incorporates the original file name into the task name.This would provide users with a clearer understanding of these optional parameters.
Also applies to: 34-35, 41-41
90-91: LGTM: Updated error section with refined descriptions.The updates to the error section, including new image references and refined descriptions, improve the overall clarity of the documentation.
Consider this minor wording improvement for better readability:
-In the process of creating a task, CVAT was not able to process the video file. +In the process of creating a task, CVAT was unable to process the video file.This change makes the sentence more concise and formal.
🧰 Tools
🪛 LanguageTool
[style] ~91-~91: Consider using “unable” to avoid wordiness.
Context: ...he process of creating a task, CVAT was not able to process the video file.
The name...(NOT_ABLE_PREMIUM)
[style] ~91-~91: Consider using a different verb for a more formal wording.
Context: ...played on the progress bar.
To fix this issue:If you want to try aga... (FIX_RESOLVE)
[style] ~91-~91: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ick Retry failed tasks.If you want to skip the file, click OK. | <!--lin... (REP_WANT_TO_VB)
site/content/en/docs/manual/basics/create_an_annotation_task.md (6)
40-41: LGTM. Don't forget to update the image.The placeholder comment is a good reminder for updating the image in the future. Ensure that the new image accurately represents the project selection process when it's ready.
Consider adding a TODO comment in your project management tool to track this image update task.
Line range hint
73-108: Excellent expansion of the Label shape section.The added content significantly improves the understanding of label shapes and their impact on the annotation process. The examples and explanations are clear and informative.
Consider adding a brief note about the performance implications (if any) of choosing different label shapes. This could help users make more informed decisions when setting up their tasks.
Line range hint
110-166: Great improvement in the Add an attribute section.The expanded content provides a much clearer explanation of attributes, their types, and how to add them. The step-by-step instructions and examples are particularly helpful.
Consider adding a brief note about best practices for naming attributes. This could help users create more consistent and easily understandable attribute names across their projects.
Line range hint
168-186: Excellent restructuring of the Select files section.The new table format greatly improves the readability and organization of information about different file upload methods. The descriptions are concise yet informative.
Consider adding a brief note about any file size limitations or supported file formats for each upload method. This could help users avoid potential issues when uploading their data.
Line range hint
246-328: Excellent expansion of the Advanced configuration section.The new table format provides a comprehensive and well-structured overview of the advanced configuration parameters. The explanations are clear, detailed, and include practical examples where needed.
Consider adding a brief note at the beginning of this section to caution users about modifying these advanced settings without a thorough understanding of their implications. This could help prevent unintended consequences for less experienced users.
Line range hint
1-328: Outstanding improvements to the Create annotation task documentation.The extensive revisions and additions throughout this document significantly enhance its clarity, completeness, and overall usefulness. The expanded sections, new examples, and improved structure make the process of creating annotation tasks much more accessible to users of all experience levels.
Consider adding a "Quick Start" or "TL;DR" section at the beginning of the document, summarizing the essential steps for creating a basic annotation task. This could help experienced users quickly refresh their memory while still providing detailed information for those who need it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (18)
site/content/en/images/create_multi_tasks_1.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_2.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_3.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_4.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_5.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_6.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_7.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_8.pngis excluded by!**/*.pngsite/content/en/images/create_multi_tasks_9.pngis excluded by!**/*.pngsite/content/en/images/image254.jpgis excluded by!**/*.jpgsite/content/en/images/image257.jpgis excluded by!**/*.jpgsite/content/en/images/image258.jpgis excluded by!**/*.jpgsite/content/en/images/image260.jpgis excluded by!**/*.jpgsite/content/en/images/image261.jpgis excluded by!**/*.jpgsite/content/en/images/image262.jpgis excluded by!**/*.jpgsite/content/en/images/image263.jpgis excluded by!**/*.jpgsite/content/en/images/multitask_configurator.pngis excluded by!**/*.pngsite/content/en/images/select_project.pngis excluded by!**/*.png
📒 Files selected for processing (4)
- cvat-ui/src/components/create-task-page/basic-configuration-form.tsx (3 hunks)
- cvat-ui/src/components/create-task-page/styles.scss (1 hunks)
- site/content/en/docs/manual/basics/create-multi-tasks.md (4 hunks)
- site/content/en/docs/manual/basics/create_an_annotation_task.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
site/content/en/docs/manual/basics/create-multi-tasks.md
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...ulti tasks**. > Note: The Сreate multi tasks feature is available for videos only....(EN_COMPOUNDS_MULTI_TASKS)
[style] ~91-~91: Consider using “unable” to avoid wordiness.
Context: ...he process of creating a task, CVAT was not able to process the video file.
The name...(NOT_ABLE_PREMIUM)
[style] ~91-~91: Consider using a different verb for a more formal wording.
Context: ...played on the progress bar.
To fix this issue:If you want to try aga... (FIX_RESOLVE)
[style] ~91-~91: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ick Retry failed tasks.If you want to skip the file, click OK. | <!--lin... (REP_WANT_TO_VB)
🔇 Additional comments (6)
cvat-ui/src/components/create-task-page/basic-configuration-form.tsx (3)
2-2: Copyright notice updated correctly.The copyright notice has been appropriately updated to reflect the current year range and the new copyright holder.
77-77: UI and documentation improvements implemented correctly.The changes enhance the user interface and improve the clarity of instructions:
- The conditional class name
cvat-task-name-field-has-tooltipallows for specific styling when the tooltip is present.- The updated tooltip text "You can use in the template:" is more direct and clear.
These modifications align well with the PR objectives of UI adjustments and documentation improvements.
Also applies to: 98-98
2-2: Changes align well with PR objectives.The modifications in this file successfully address two main objectives of the PR:
- UI Adjustments: The new conditional class name allows for improved styling of the task name field.
- Documentation Improvements: The updated tooltip text provides clearer instructions for users.
These changes, along with the copyright update, contribute to an enhanced user experience and more accurate documentation.
Also applies to: 77-77, 98-98
site/content/en/docs/manual/basics/create-multi-tasks.md (3)
15-15: LGTM: Updated image reference.The image update aligns with the PR objective to refresh visuals, likely providing a more accurate representation of the current UI.
65-65: LGTM: Updated example section visuals.The image updates in the example section align with the PR objective to refresh visuals. These changes likely provide users with a more accurate representation of the current UI and process flow.
Also applies to: 68-68, 72-72, 76-76, 80-80
Line range hint
1-108: Overall assessment: Documentation improvements are well-implemented.The changes in this file successfully address the PR objectives:
- The documentation text has been revised to improve clarity and accuracy.
- Visual references (screenshots) have been updated to reflect the current UI.
- The layout and structure of the document have been enhanced for better readability.
A few minor suggestions were made to further improve the content. Once these are addressed, the updated documentation should provide users with a more accurate and helpful guide for creating multiple tasks in CVAT.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #8516 +/- ##
===========================================
- Coverage 74.33% 74.29% -0.04%
===========================================
Files 397 397
Lines 43139 43139
Branches 3905 3905
===========================================
- Hits 32066 32052 -14
- Misses 11073 11087 +14
|
|
Motivation and context
How has this been tested?
Checklist
developbranch[ ] I have added tests to cover my changes[ ] I have linked related issues (see GitHub docs)[ ] I have increased versions of npm packages if it is necessary(cvat-canvas,
cvat-core,
cvat-data and
cvat-ui)
License
Feel free to contact the maintainers if that's a concern.
Summary by CodeRabbit
New Features
Bug Fixes
Documentation