You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Need to clear grammatical issues, paraphrasing for both Chat and AIAssist View widget.
Need to correct the grammatical mistakes for above mentioned Chat Section in the Flutter User Guide documentation widget by using the Syncfusion Continue AI.
Analysis and design
Copy the UG content with code snippet and modify it in Continue AI based on the shared prompt. Modify the shared prompt based on your needs if needed.
Replace the hyperlink given by the AI with the original hyperlink.
Ensure naming casing of the widget.
Replace the existing code snippet alignment with AI code snippet in proper alignment.
Prompt:
Use the prompt below for UG review in AI-Continue.
Review the following User Guide(UG) document based on the criteria below. After reviewing, rewrite and share the updated content. If any modifications are made during the review, clearly indicate what was changed and why.
Review Criteria:
Spelling: Identify and correct any spelling errors.
Grammar: Fix grammatical mistakes and awkward phrasing to improve readability.
Technical Accuracy: Ensure the correct usage of technical terms, product names, and APIs (e.g., Syncfusion, Flutter).
Formatting: Verify proper formatting for code blocks, markdown syntax, and hyperlinks.
Consistency: Maintain consistent terminology, phrasing, and capitalization throughout the document.
Clarity: Improve sentence structure and flow while preserving technical accuracy and intent.
Tone: Maintain a professional, developer-friendly, and instructional tone appropriate for technical documentation.
Links & References: Check that all links are functional and point to relevant, up-to-date resources.
Tags: Suggest relevant tags or keywords based on the document’s content for categorization and searchability.
Solution description
Checked and cleared the grammatical issues, paraphrasing for all the chat and assist view widget UG documentation pages.
Output screenshots
Post the output screenshots if an UI is affected or added due to this feature.
Areas affected and ensured
No, areas affected.
API Changes
List all API changes here (or just put None), example:
Provide the unit testing written file details to understand the use cases considered in this implementation.
If there is no TDD (if it’s not possible to follow), provide the UI automation script location and the Excel file that contains the use cases considered in this implementation.
Provide the test cases Excel file alone if the feature cannot be automated in any case.
List out all the scenarios you have tested after include these changes. You can refer the predefined scenarios from below link.
Provide the test bed sample location where code reviewers can review the new feature’s behaviors. This depends on the CI process that your team follows. It can be from NPMCI, HockeyApp, staging site, local server, etc.
Does it have any known issues?
No.
Does it have memory leak?
Not applicable.
MR CheckList
Does it follow the design guidelines? It is mandatory that, we should not move the changes without reading this.
Did UI automation passed without errors? If it is customer issue, make sure it is included in the IR automation.
Ensured in iOS, Android, UWP and macOS (if supported).
Have you added API comments if it is new API?
Does it need localization? If so, update resx file in GitHub.
Whether we have added new APIs? If so, whether it is as per the guidelines?
If changes are made in the Xamarin.Forms sample browser project file, whether it is included in the props file too? If not, your sample level changes will not reflect in the application published in the hockey app.
Have you ensured the changes in Android API 19 and iOS 9?
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.
Feature description
Analysis and design
Copy the UG content with code snippet and modify it in Continue AI based on the shared prompt. Modify the shared prompt based on your needs if needed.
Replace the hyperlink given by the AI with the original hyperlink.
Ensure naming casing of the widget.
Replace the existing code snippet alignment with AI code snippet in proper alignment.
Prompt:
Use the prompt below for UG review in AI-Continue.
Review the following User Guide(UG) document based on the criteria below. After reviewing, rewrite and share the updated content. If any modifications are made during the review, clearly indicate what was changed and why.
Review Criteria:
Solution description
Checked and cleared the grammatical issues, paraphrasing for all the chat and assist view widget UG documentation pages.
Output screenshots
Post the output screenshots if an UI is affected or added due to this feature.
Areas affected and ensured
No, areas affected.
API Changes
List all API changes here (or just put None), example:
Added:
Changed:
Behavioral Changes
No behavioral changes.
Test cases
Provide the unit testing written file details to understand the use cases considered in this implementation.
If there is no TDD (if it’s not possible to follow), provide the UI automation script location and the Excel file that contains the use cases considered in this implementation.
Provide the test cases Excel file alone if the feature cannot be automated in any case.
List out all the scenarios you have tested after include these changes. You can refer the predefined scenarios from below link.
https://syncfusion.atlassian.net/wiki/display/CHARTXAMARIN/Chart+Test+Plan
Testbed sample location
Provide the test bed sample location where code reviewers can review the new feature’s behaviors. This depends on the CI process that your team follows. It can be from NPMCI, HockeyApp, staging site, local server, etc.
Does it have any known issues?
No.
Does it have memory leak?
Not applicable.
MR CheckList