Cu 86c060qh5 documentation add user guide for UI #316
Conversation
|
Task linked: CU-86c060qh5 Documentation: Add user guide for UI |
WalkthroughThe changes include the renaming of the "User Interface User Guide" to "User Interface Guide" and the addition of a new "Configuration User Guide" entry in the documentation summary. Two comprehensive user guides have been introduced, detailing functionalities and configuration settings for managing patient data within a system utilizing MPI. Additionally, image paths in several documentation files have been updated for clarity and accessibility. Changes
Possibly related PRs
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: 0
Outside diff range, codebase verification and nitpick comments (5)
documentation/ui-user-guide.md (5)
2-3: Fix the grammatical issue.The second sentence has a grammatical issue. It should be rewritten as follows:
-the best fit the desired implementation of the MPI. +that best fit the desired implementation of the MPI.Tools
LanguageTool
[uncategorized] ~2-~2: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
37-46: Fix the formatting and grammatical issues.The "Design view" subsection has the following issues:
- The word "dropdown" should be spelled as one word.
- The abbreviation "etc." should have a period at the end.
- The phrase "add add icon button" has a repeated word.
Apply this diff to fix the issues:
-this view allows the user to do the following : +This view allows the user to do the following: -Select the operator values from a drop down field eg "And" and "Or" +- Select the operator values from a dropdown field, e.g., "And" and "Or" -Select common field values from a drop down field +- Select common field values from a dropdown field -Select comparator function from a drop down field eg "Exact", "Low Fuzziness" etc +- Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness", etc. -Add a second row of input fields by selecting the add add icon button +- Add a second row of input fields by selecting the add icon buttonTools
LanguageTool
[uncategorized] ~40-~40: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~41-~41: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~42-~42: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~42-~42: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~43-~43: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
37-37: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
48-73: Fix the grammatical issues.The "Blocking" section has the following grammatical issues:
- The phrase "The blocking tabs has two sub tabs" has a subject-verb agreement error. It should be "The blocking tab has two sub tabs".
- The phrase "This view must allows the user to do the following" has a modal verb error. It should be "This view allows the user to do the following".
- The word "dropdown" should be spelled as one word.
- The abbreviation "etc." should have a period at the end.
- The phrase "add add icon button" has a repeated word.
Apply this diff to fix the issues:
-The blocking tabs has two sub tabs : +The blocking tab has two sub tabs: -This view must allows the user to do the following : +This view allows the user to do the following: -Select the operator values from a drop down field eg "And" and "Or" +- Select the operator values from a dropdown field, e.g., "And" and "Or" -Select common field values from a drop down field. +- Select common field values from a dropdown field. -Select comparator function from a drop down field eg "Exact", "Low Fuzziness" etc +- Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness", etc. -Add a second row of input fields by selecting the add add icon button +- Add a second row of input fields by selecting the add icon buttonTools
LanguageTool
[grammar] ~51-~51: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~64-~64: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~66-~66: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~67-~67: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~68-~68: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...ct comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc - Add a...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~68-~68: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~69-~69: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
62-62: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
75-76: Add the missing comma.A comma should be added after the word "tab" in the first sentence.
-In the Probabilistic tab the user can define the linking threshold ranges and/or values. +In the Probabilistic tab, the user can define the linking threshold ranges and/or values.Tools
LanguageTool
[uncategorized] ~76-~76: Possible missing comma found.
Context: ...Probabilistic* In the Probabilistic tab the user can define the linking thresho...(AI_HYDRA_LEO_MISSING_COMMA)
87-96: Fix the formatting issues.The "Nodes" section has the following formatting issues:
- The list items have inconsistent indentation.
- The abbreviation "e.g." should have two periods.
Apply this diff to fix the issues:
-Golden record node shows properties unique to the golden record. -Interaction node shows properties unique to the interaction.Source ID : +- Golden record node shows properties unique to the golden record. +- Interaction node shows properties unique to the interaction. +- Source ID: -The third node denoted e.g Source ID, shows unique common lists e.g + The third node, denoted e.g., Source ID, shows unique common lists, e.g., - - Source ID list - - Biometric ID list + - Source ID list + - Biometric ID listTools
LanguageTool
[uncategorized] ~94-~94: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~94-~94: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
88-88: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
88-88: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
95-95: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
96-96: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- documentation/SUMMARY.md (1 hunks)
- documentation/ui-user-guide.md (1 hunks)
Files skipped from review due to trivial changes (1)
- documentation/SUMMARY.md
Additional context used
LanguageTool
documentation/ui-user-guide.md
[uncategorized] ~2-~2: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
[uncategorized] ~40-~40: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~41-~41: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~42-~42: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~42-~42: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~43-~43: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~51-~51: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~64-~64: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~66-~66: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~67-~67: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~68-~68: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...ct comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc - Add a...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~68-~68: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~69-~69: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~76-~76: Possible missing comma found.
Context: ...Probabilistic* In the Probabilistic tab the user can define the linking thresho...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~94-~94: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~94-~94: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
88-88: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
88-88: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
95-95: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
96-96: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
6-6: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
22-22: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
37-37: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
62-62: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (2)
documentation/ui-user-guide.md (2)
6-21: LGTM!The "Common Properties" section looks good.
Tools
Markdownlint
6-6: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
81-85: LGTM!The "Rules on threshold slider" and "Rules on Threshold" sections look good.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- documentation/backup-and-restore.md (2 hunks)
- documentation/sso.md (1 hunks)
Files skipped from review due to trivial changes (1)
- documentation/backup-and-restore.md
Additional context used
Markdownlint
documentation/sso.md
48-48: null
Bare URL used(MD034, no-bare-urls)
Additional comments not posted (2)
documentation/sso.md (2)
45-45: LGTM!The code change is approved.
50-50: LGTM!The code changes are approved.
Also applies to: 54-54
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (2)
documentation/ui-user-guide.md (2)
7-48: Fix minor issues.The segment provides good details about the Confusion Matrix tab. Please address the following minor issues:
- Line 10: "sub-divided" should be spelled as one word.
- Line 25: The image alt text is missing.
Tools
LanguageTool
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
Markdownlint
45-45: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
12-12: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-90: Fix minor issues.The segment provides good details about the M & U values tab. Please address the following minor issues:
- Line 57: "cross-checking" should be spelled with a hyphen.
- Line 62: The image alt text is missing.
Tools
LanguageTool
[grammar] ~57-~57: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
Markdownlint
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
67-67: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
86-86: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/ui-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/ui-user-guide.md
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
[grammar] ~57-~57: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
[uncategorized] ~108-~108: Possible missing comma found.
Context: ...r : - The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~135-~135: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~136-~136: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~137-~137: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~137-~137: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~138-~138: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~147-~147: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~160-~160: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~162-~162: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~162-~162: Possible missing comma found.
Context: ...ct the operator values from a drop down field eg “And” and “Or” - Select common field...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~163-~163: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~164-~164: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~164-~164: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~165-~165: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~195-~195: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~195-~195: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
45-45: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
187-187: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
188-188: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
189-189: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
187-187: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
188-188: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
189-189: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
196-196: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
197-197: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
12-12: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
67-67: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
86-86: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
92-92: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
98-98: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
116-116: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
158-158: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
documentation/ui-user-guide.md (1)
1-5: LGTM!The code changes are approved.
documentation/ui-user-guide.md
Outdated
| **Common Properties** | ||
|
|
||
| This tab defines the demographic details for a patient that will be used for linking. | ||
|  | ||
|
|
||
| **The user can do the following:** | ||
|
|
||
| - Select the Edit icon button to initiate edit mode on a row for the common properties. | ||
|
|
||
| When the row is in edit mode the following changes occur : | ||
| - The colour of the row changes to white | ||
| The edit icon changes to show a save icon and a close icon | ||
|  | ||
|
|
||
| - Choose to select the close button to exit edit mode. | ||
| - Choose to select the save icon button to save changes made and exit edit mode. | ||
| - Edit the relevant fields and select the save button to save changes on the current tab. | ||
|
|
||
| **Deterministic** | ||
|
|
||
| The deterministic tab is used to define the deterministic rules. | ||
| The deterministic tab has three sub tabs : | ||
| - Linking | ||
| - Validate | ||
| - Matching | ||
|
|
||
| **Source view** | ||
|
|
||
| This view allows the user to do the following : | ||
| - View the displayed rules | ||
| - Click edit mode by clicking the edit icon button which opens up the design view | ||
| - Click add icon button which initiates edit mode , switches to design view tab (If there are no existing rules on display) | ||
|  | ||
|
|
||
| **Design view** | ||
|
|
||
| This view allows the user to do the following : | ||
| - Select the operator values from a drop down field eg “And” and “Or” | ||
| - Select common field values from a drop down field | ||
| - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc | ||
| - Add a second row of input fields by selecting the add add icon button | ||
| - Save rule by selecting the add rule button | ||
| - Exit edit mode and cancel previous edits. | ||
| - Delete existing row of input fields | ||
|  | ||
|
|
||
| **Blocking** | ||
| The blocking tab is used to define the blocking rules. | ||
|
|
||
| The blocking tabs has two sub tabs : | ||
| - Linking | ||
| - Matching | ||
|
|
||
| The blocking sub tabs have two different views : | ||
| Source view This view allows the user to do the following : | ||
| - View the displayed rules | ||
| - Click edit mode by clicking the edit icon button which opens up the design view | ||
| - Click add icon button which initiates edit mode , switches to design view tab (If there are no existing rules on display)! | ||
| [Blocking Source View](.gitbook/assets/23) | ||
|
|
||
| **Design view** | ||
|
|
||
| This view must allows the user to do the following : | ||
|
|
||
| - Select the operator values from a drop down field eg “And” and “Or” | ||
| - Select common field values from a drop down field. | ||
| - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc | ||
| - Add a second row of input fields by selecting the add add icon button | ||
| - Save rule by selecting the add rule button | ||
| - Exit edit mode and cancel previous edits. | ||
| - Delete existing row of input fields | ||
|  | ||
|
|
||
| **Probabilistic** | ||
| In the Probabilistic tab the user can define the linking threshold ranges and/or values. | ||
|
|
||
| All values must be entered as per the rules defined. | ||
|  | ||
|
|
||
| **Rules on threshold slider** | ||
| - Do not allow the link threshold (green circle): | ||
| - To be < the Minimum threshold review value | ||
| - To be > the Maximum threshold review value | ||
|
|
||
| **Rules on Threshold** | ||
| For all threshold values that are entered, system allows for exponential notation e.g. 123E-3 which is the same as 0.012System display default values | ||
|
|
||
| **Nodes** | ||
| This section displays the following : | ||
| - Golden record node | ||
| - Interaction node | ||
| - Source ID | ||
|
|
||
|  | ||
|
|
||
| Golden record node shows properties unique to the golden record. | ||
| Interaction node shows properties unique to the interaction.Source ID : | ||
| The third node denoted e.g Source ID, shows unique common lists e.g | ||
| - Source ID list | ||
| - Biometric ID list |
There was a problem hiding this comment.
Fix issues flagged by static analysis tools.
The segment provides good details about the Configuration Settings screen and its tabs. However, there are several issues flagged by static analysis tools that need to be fixed:
- Line 108: Possible missing comma.
- Line 129: The preposition "to" seems more likely than "on".
- Lines 135, 136, 137, 162, 163, 164: "dropdown" should be spelled as one word.
- Lines 137, 164: Abbreviations like "etc." require a period.
- Lines 138, 165: The word "add" is repeated.
- Line 147: The verb form "has" does not match the subject "tabs".
- Line 160: The modal verb "must" requires the verb's base form.
- Line 162: Possible missing comma.
- Lines 187-189, 196-197: Inconsistent indentation for list items at the same level.
- Line 195: The abbreviation "e.g." requires two periods.
Do you want me to submit a PR to fix these issues?
Tools
LanguageTool
[uncategorized] ~108-~108: Possible missing comma found.
Context: ...r : - The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~129-~129: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~135-~135: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~136-~136: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~137-~137: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~137-~137: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~138-~138: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~147-~147: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~160-~160: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~162-~162: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~162-~162: Possible missing comma found.
Context: ...ct the operator values from a drop down field eg “And” and “Or” - Select common field...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~163-~163: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~164-~164: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~164-~164: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~165-~165: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~195-~195: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~195-~195: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
187-187: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
188-188: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
189-189: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
187-187: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
188-188: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
189-189: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
196-196: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
197-197: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
92-92: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
98-98: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
116-116: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
158-158: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (2)
documentation/user-interface-user-guide.md (2)
6-20: Fix minor issues in the "Common Properties" section.The section provides clear instructions for editing the common properties. However, there are a few minor issues:
- Add a comma after "mode" in the sentence "When the row is in edit mode the following changes occur :".
- Add the file extension ".png" to the image path for "Common Properties Edit Mode".
Apply this diff to fix the issues:
-When the row is in edit mode the following changes occur : +When the row is in edit mode, the following changes occur: - +Tools
LanguageTool
[uncategorized] ~12-~12: A comma might be missing here.
Context: ...mon properties. When the row is in edit mode the following changes occur : The colou...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
90-102: Fix minor issues in the "Nodes" section.The section provides a clear list of the nodes displayed in the UI. However, there are a few minor issues based on the hints from static analysis tools:
- Add the article "the" before "Golden record node" in the sentence "Golden record node shows properties unique to the golden record."
- Add periods after "e.g" in both occurrences.
Apply this diff to fix the issues:
-Golden record node shows properties unique to the golden record. +The Golden record node shows properties unique to the golden record. -Source ID : The third node denoted e.g Source ID, shows unique common lists e.g +Source ID: The third node denoted e.g. Source ID, shows unique common lists, e.g.,Tools
LanguageTool
[uncategorized] ~97-~97: You might be missing the article “the” here.
Context: ...ource IDGolden record node shows properties unique to ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~100-~100: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~100-~100: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/user-interface-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/user-interface-user-guide.md
[uncategorized] ~12-~12: A comma might be missing here.
Context: ...mon properties. When the row is in edit mode the following changes occur : The colou...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~33-~33: You might be missing the article “the” here.
Context: ... which opens up the design view - Click add icon button which initiates edit mode ,...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~38-~38: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~39-~39: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~40-~40: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~40-~40: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~41-~41: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ode and cancel previous edits. - Delete existing row of input fields ![Determistic Desig...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~50-~50: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ...the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[uncategorized] ~60-~60: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~64-~64: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ets/23) Design view This view must allows the user to do the following : - Selec...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~66-~66: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~66-~66: A comma might be missing here.
Context: ...ct the operator values from a drop down field eg “And” and “Or” - Select common field...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~67-~67: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~68-~68: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~68-~68: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~69-~69: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~72-~72: You might be missing the article “the” here.
Context: ...ode and cancel previous edits. - Delete existing row of input fields ![Blocking Design V...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~97-~97: You might be missing the article “the” here.
Context: ...ource ID(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~100-~100: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~100-~100: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Markdownlint
documentation/user-interface-user-guide.md
81-81: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Additional comments not posted (2)
documentation/user-interface-user-guide.md (2)
1-5: LGTM!The "Configuration Settings" section provides a clear overview and includes a relevant image for visual context.
75-89: LGTM!The "Probabilistic" section provides clear instructions and includes a relevant image for visual context.
Tools
Markdownlint
81-81: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
…-user-guide-for-UI' into CU-86c060qh5_Documentation-Add-user-guide-for-UI
There was a problem hiding this comment.
Actionable comments posted: 8
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/ui-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/ui-user-guide.md
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
[grammar] ~57-~57: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
[grammar] ~128-~128: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~136-~136: Consider a shorter alternative to avoid wordiness.
Context: ... to the GR are displayed under the GR. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[typographical] ~160-~160: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...lden records and/or - Refine the search in order to view other candidate golden records **...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~218-~218: There should be a space after a closing quote.
Context: ...yed as “searched” as opposed to “blocked”when raised by a notification. ![Review Lin...(NO_SPACE_CLOSING_QUOTE)
[uncategorized] ~291-~291: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~292-~292: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~293-~293: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~293-~293: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~294-~294: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~303-~303: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~316-~316: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~318-~318: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~319-~319: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~320-~320: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~320-~320: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~321-~321: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~351-~351: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~351-~351: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
45-45: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
343-343: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
344-344: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
345-345: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
343-343: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
344-344: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
345-345: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
352-352: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
353-353: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
12-12: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
38-38: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
67-67: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
74-74: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
86-86: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
92-92: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
94-94: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
109-109: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
113-113: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
131-131: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
157-157: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
165-165: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
190-190: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
196-196: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
209-209: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
229-229: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
248-248: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
254-254: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
288-288: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
314-314: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
documentation/ui-user-guide.md (1)
128-128: Possible missing word after 'a'.It seems there might be a missing word after 'a' in the sentence. This could lead to confusion or misinterpretation.
Consider rephrasing for clarity:
- a. If no results are found, the system displays a message informing the user that there are no results found. + a. If no results are found, the system displays a message informing the user that no results were found.Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~128-~128: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
There was a problem hiding this comment.
Actionable comments posted: 5
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/ui-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/ui-user-guide.md
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
[grammar] ~58-~58: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
[grammar] ~133-~133: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~141-~141: Consider a shorter alternative to avoid wordiness.
Context: ... to the GR are displayed under the GR. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[typographical] ~166-~166: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
[uncategorized] ~191-~191: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~196-~196: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~213-~213: Consider a shorter alternative to avoid wordiness.
Context: ...lden records and/or - Refine the search in order to view other candidate golden records **...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~224-~224: There should be a space after a closing quote.
Context: ...yed as “searched” as opposed to “blocked”when raised by a notification. ![Review Lin...(NO_SPACE_CLOSING_QUOTE)
[uncategorized] ~228-~228: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~260-~260: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s automatically matched to Golden record but the matching scores fall within the Rev...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~266-~266: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... yet - Open - notification has been read but no action has been taken yet - Closed -...(COMMA_COMPOUND_SENTENCE_2)
[style] ~281-~281: Consider a shorter alternative to avoid wordiness.
Context: ... you want to extend the search criteria in order to search for possible candidate golden re...(IN_ORDER_TO_PREMIUM)
[typographical] ~289-~289: Consider putting a comma before the abbreviation “i.e.”.
Context: ...ere are 2 types of searches that can be done i.e. Custom search and a normal search 3. Th...(IE_COMMA)
[grammar] ~315-~315: The word ‘create’ is a verb. Did you mean the noun “creation”?
Context: ...there is only one interaction, then the create new golden record option is disabled. ...(PREPOSITION_VERB)
[uncategorized] ~343-~343: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
[uncategorized] ~384-~384: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~385-~385: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~386-~386: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~386-~386: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~387-~387: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~396-~396: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~409-~409: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~411-~411: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~411-~411: Possible missing comma found.
Context: ...ct the operator values from a drop down field eg “And” and “Or” - Select common field...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~412-~412: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~413-~413: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[uncategorized] ~413-~413: Possible missing comma found.
Context: ...ct comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc - Add a...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~413-~413: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~414-~414: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~421-~421: Possible missing comma found.
Context: ...Probabilistic* In the Probabilistic tab the user can define the linking thresho...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~444-~444: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~444-~444: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
45-45: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
436-436: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
437-437: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
438-438: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
336-336: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
337-337: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
436-436: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
437-437: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
438-438: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
445-445: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
446-446: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
12-12: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
38-38: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
56-56: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
69-69: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
77-77: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
91-91: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
97-97: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
99-99: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
136-136: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
144-144: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
163-163: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
171-171: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
196-196: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
202-202: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
215-215: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
235-235: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
253-253: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
279-279: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
283-283: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
303-303: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
305-305: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
312-312: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
327-327: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
341-341: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
347-347: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
365-365: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
381-381: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
407-407: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Images should have alternate text (alt text)(MD045, no-alt-text)
285-285: null
Images should have alternate text (alt text)(MD045, no-alt-text)
310-310: null
Images should have alternate text (alt text)(MD045, no-alt-text)
339-339: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (3)
documentation/ui-user-guide.md (3)
409-409: Correct modal verb usage.The modal verb "must" is incorrectly followed by "allows" instead of "allow".
Apply this diff to correct the modal verb usage:
- This view must allows the user to do the following : + This view must allow the user to do the following :Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~409-~409: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
10-10: Correct spelling for "sub-divided".The term "sub-divided" should be spelled as "subdivided" without a hyphen. This correction aligns with standard English usage and enhances the document's professionalism.
Apply this diff to correct the spelling:
- This tab is sub-divided into 3 sections, starting with the right, the Confusion Matrix. + This tab is subdivided into 3 sections, starting with the right, the Confusion Matrix.Likely invalid or redundant comment.
Tools
LanguageTool
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
58-58: Correct spelling for "cross-checking".The term "cross checking" should be spelled with a hyphen as "cross-checking". This correction ensures consistency with standard English practices.
Apply this diff to correct the spelling:
- The Tally method computes M & U’s per field which is used for cross checking against the M&U’s computed by the EM algorithm. + The Tally method computes M & U’s per field which is used for cross-checking against the M&U’s computed by the EM algorithm.Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~58-~58: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/ui-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/ui-user-guide.md
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
[grammar] ~58-~58: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
[grammar] ~133-~133: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~141-~141: Consider a shorter alternative to avoid wordiness.
Context: ... to the GR are displayed under the GR. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[typographical] ~166-~166: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
[uncategorized] ~176-~176: Possible missing comma found.
Context: ...will be allowed on any system generated fields e.g. Golden ID. The fields that are ed...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~191-~191: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
[style] ~213-~213: Consider a shorter alternative to avoid wordiness.
Context: ...lden records and/or - Refine the search in order to view other candidate golden records **...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~224-~224: There should be a space after a closing quote.
Context: ...yed as “searched” as opposed to “blocked”when raised by a notification. ![Review Lin...(NO_SPACE_CLOSING_QUOTE)
[uncategorized] ~228-~228: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~230-~230: Possible missing article found.
Context: ...ion is selected, the relink is done and system displays a successful message b. If t...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~260-~260: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s automatically matched to Golden record but the matching scores fall within the Rev...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~266-~266: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... yet - Open - notification has been read but no action has been taken yet - Closed -...(COMMA_COMPOUND_SENTENCE_2)
[style] ~281-~281: Consider a shorter alternative to avoid wordiness.
Context: ... you want to extend the search criteria in order to search for possible candidate golden re...(IN_ORDER_TO_PREMIUM)
[typographical] ~289-~289: Consider putting a comma before the abbreviation “i.e.”.
Context: ...ere are 2 types of searches that can be done i.e. Custom search and a normal search 3. Th...(IE_COMMA)
[grammar] ~315-~315: The word ‘create’ is a verb. Did you mean the noun “creation”?
Context: ...there is only one interaction, then the create new golden record option is disabled. ...(PREPOSITION_VERB)
[uncategorized] ~334-~334: Possible missing preposition found.
Context: ...stem displays a confirmation message 4. Select the CONFIRM button. 5. The system: -...(AI_HYDRA_LEO_MISSING_TO)
[style] ~352-~352: Consider a shorter alternative to avoid wordiness.
Context: ...tion** Select one of the options below in order to configure machine learning: 1. Send to ...(IN_ORDER_TO_PREMIUM)
[typographical] ~380-~380: Consider putting a comma before the abbreviation “i.e.”.
Context: ...until all required selections have been made i.e. file must be uploaded, configuration se...(IE_COMMA)
[uncategorized] ~412-~412: Possible missing comma found.
Context: ...r : - The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~433-~433: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~439-~439: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~440-~440: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~441-~441: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~441-~441: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~442-~442: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~451-~451: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~464-~464: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~466-~466: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~466-~466: Possible missing comma found.
Context: ...ct the operator values from a drop down field eg “And” and “Or” - Select common field...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~467-~467: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~468-~468: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~468-~468: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~469-~469: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~499-~499: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~499-~499: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
45-45: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
491-491: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
492-492: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
493-493: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
45-45: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
336-336: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
337-337: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
491-491: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
492-492: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
493-493: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
500-500: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
501-501: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
12-12: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
27-27: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
38-38: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
42-42: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
49-49: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
56-56: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
69-69: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
77-77: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
91-91: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
97-97: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
99-99: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
136-136: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
144-144: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
163-163: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
171-171: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
196-196: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
202-202: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
215-215: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
235-235: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
253-253: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
279-279: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
283-283: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
303-303: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
305-305: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
312-312: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
327-327: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
341-341: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
350-350: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
356-356: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
370-370: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
392-392: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
396-396: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
402-402: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
420-420: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
436-436: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
462-462: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Images should have alternate text (alt text)(MD045, no-alt-text)
285-285: null
Images should have alternate text (alt text)(MD045, no-alt-text)
310-310: null
Images should have alternate text (alt text)(MD045, no-alt-text)
339-339: null
Images should have alternate text (alt text)(MD045, no-alt-text)
394-394: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (9)
documentation/ui-user-guide.md (9)
10-10: Correct spelling for "sub-divided".The term "sub-divided" should be spelled as "subdivided" without a hyphen. This correction aligns with standard English usage and enhances the document's professionalism.
Tools
LanguageTool
[misspelling] ~10-~10: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
58-58: Correct spelling for "cross-checking".The term "cross checking" should be spelled with a hyphen as "cross-checking". This correction ensures adherence to grammatical standards and improves the readability of the document.
Tools
LanguageTool
[grammar] ~58-~58: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
133-133: Add missing word for clarity.It appears a word may be missing after 'a', which could lead to confusion. Consider rephrasing for clarity:
- a. If no results are found, the system displays a message informing the user that there are no results found. + a. If no results are found, the system displays a message informing the user that no results are available.Tools
LanguageTool
[grammar] ~133-~133: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
166-166: Add comma before 'i.e.' for clarity.It's standard to include a comma before "i.e." to improve readability:
- the full audit trail for the patient is displayed i.e. all the events that occurred on each interaction are displayed. + the full audit trail for the patient is displayed, i.e., all the events that occurred on each interaction are displayed.Tools
LanguageTool
[typographical] ~166-~166: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
464-464: Correct modal verb usage.The modal verb "must" is incorrectly followed by "allows" instead of "allow":
- This view must allows the user to do the following : + This view must allow the user to do the following :Tools
LanguageTool
[grammar] ~464-~464: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
442-442: Remove duplicated word 'add'.The word 'add' is repeated in the text, which is likely a typographical error:
- Add a second row of input fields by selecting the add add icon button + Add a second row of input fields by selecting the add icon buttonTools
LanguageTool
[duplication] ~442-~442: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
451-451: Correct verb form to match the plural subject.The verb "has" does not agree with the plural subject "tabs":
- The blocking tabs has two sub tabs : + The blocking tabs have two sub tabs :Tools
LanguageTool
[grammar] ~451-~451: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
499-499: Correct abbreviation 'e.g.'The abbreviation "e.g." should have two periods:
- The third node denoted e.g Source ID, shows unique common lists e.g + The third node denoted e.g., Source ID, shows unique common lists e.g.,Tools
LanguageTool
[uncategorized] ~499-~499: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~499-~499: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
439-441: Consolidate corrections for 'dropdown' and 'etc.'The term "dropdown" should be spelled as one word, and the abbreviation "etc." should always be followed by a period:
- Select the operator values from a drop down field eg “And” and “Or” - Select common field values from a drop down field - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc + Select the operator values from a dropdown field, e.g., “And” and “Or” + Select common field values from a dropdown field + Select comparator function from a dropdown field, e.g., “Exact”, “Low Fuzziness,” etc.Tools
LanguageTool
[uncategorized] ~439-~439: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~440-~440: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~441-~441: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~441-~441: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
There was a problem hiding this comment.
Actionable comments posted: 23
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- documentation/ui-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/ui-user-guide.md
[typographical] ~6-~6: Consider putting a comma before the abbreviation “i.e.”.
Context: ...ccessible to the user. There are 4 main screens i.e. Dashboard, Browse, Notifications and Im...(IE_COMMA)
[uncategorized] ~26-~26: Possible missing comma found.
Context: ...t are referred to as candidate (golden) records as they are potential candidates for li...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~32-~32: Consider putting a comma before the abbreviation “i.e.”.
Context: ...n record links records based on a match score i.e. determines that 2 or more patient recor...(IE_COMMA)
[uncategorized] ~34-~34: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...o the same person. Always has the most up to date information for a patient by consensus ...(UP_TO_DATE_HYPHEN)
[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...g is performed with different criteria (e.g such as another condition with differen...(E_G)
[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...perform filtering instead of blocking. (e.g Find all males in village x) **Similar...(E_G)
[misspelling] ~86-~86: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
[uncategorized] ~134-~134: Possible missing comma found.
Context: ... The Tally method computes M & U’s per field which is used for cross checking agains...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~134-~134: The word “cross-checking” is spelled with a hyphen.
Context: ...tes M & U’s per field which is used for cross checking against the M&U’s computed by the EM al...(CROSS_COMPOUNDS)
[uncategorized] ~151-~151: Possible missing article found.
Context: ... If admin rejects this assumption, then system must subtract 0.8 from A or B and add t...(AI_HYDRA_LEO_MISSING_THE)
[grammar] ~209-~209: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~217-~217: Consider a shorter alternative to avoid wordiness.
Context: ... to the GR are displayed under the GR. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[typographical] ~242-~242: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
[uncategorized] ~252-~252: Possible missing comma found.
Context: ...will be allowed on any system generated fields e.g. Golden ID. The fields that are ed...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~267-~267: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~289-~289: Consider a shorter alternative to avoid wordiness.
Context: ...lden records and/or - Refine the search in order to view other candidate golden records **...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~300-~300: There should be a space after a closing quote.
Context: ...yed as “searched” as opposed to “blocked”when raised by a notification. ![Review Lin...(NO_SPACE_CLOSING_QUOTE)
[uncategorized] ~304-~304: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~338-~338: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s automatically matched to Golden record but the matching scores fall within the Rev...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~344-~344: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... yet - Open - notification has been read but no action has been taken yet - Closed -...(COMMA_COMPOUND_SENTENCE_2)
[style] ~359-~359: Consider a shorter alternative to avoid wordiness.
Context: ... you want to extend the search criteria in order to search for possible candidate golden re...(IN_ORDER_TO_PREMIUM)
[typographical] ~367-~367: Consider putting a comma before the abbreviation “i.e.”.
Context: ...ere are 2 types of searches that can be done i.e. Custom search and a normal search 3. Th...(IE_COMMA)
[grammar] ~393-~393: The word ‘create’ is a verb. Did you mean the noun “creation”?
Context: ...there is only one interaction, then the create new golden record option is disabled. ...(PREPOSITION_VERB)
[style] ~430-~430: Consider a shorter alternative to avoid wordiness.
Context: ...tion** Select one of the options below in order to configure machine learning: 1. Send to ...(IN_ORDER_TO_PREMIUM)
[typographical] ~458-~458: Consider putting a comma before the abbreviation “i.e.”.
Context: ...until all required selections have been made i.e. file must be uploaded, configuration se...(IE_COMMA)
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~529-~529: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
[grammar] ~542-~542: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
[uncategorized] ~544-~544: The noun “dropdown” is spelled as one word.
Context: ... : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~545-~545: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field. - Select comparator function fro...(LOCKDOWN)
[uncategorized] ~546-~546: The noun “dropdown” is spelled as one word.
Context: ...ld. - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~546-~546: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~547-~547: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~554-~554: Possible missing comma found.
Context: ...Probabilistic* In the Probabilistic tab the user can define the linking thresho...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~577-~577: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...on.Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~577-~577: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID ...(E_G)
Markdownlint
documentation/ui-user-guide.md
121-121: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
569-569: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
570-570: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
571-571: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
121-121: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
414-414: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
415-415: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
569-569: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
570-570: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
571-571: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
578-578: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
579-579: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
2-2: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
22-22: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
88-88: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
125-125: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
145-145: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
153-153: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
167-167: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
175-175: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
190-190: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
220-220: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
239-239: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
247-247: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
278-278: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
291-291: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
311-311: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
329-329: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
331-331: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
357-357: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
361-361: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
381-381: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
383-383: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
390-390: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
405-405: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
419-419: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
428-428: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
434-434: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
448-448: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
470-470: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
474-474: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
480-480: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
498-498: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
514-514: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
540-540: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
12-12: null
Images should have alternate text (alt text)(MD045, no-alt-text)
16-16: null
Images should have alternate text (alt text)(MD045, no-alt-text)
20-20: null
Images should have alternate text (alt text)(MD045, no-alt-text)
139-139: null
Images should have alternate text (alt text)(MD045, no-alt-text)
363-363: null
Images should have alternate text (alt text)(MD045, no-alt-text)
388-388: null
Images should have alternate text (alt text)(MD045, no-alt-text)
417-417: null
Images should have alternate text (alt text)(MD045, no-alt-text)
472-472: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (9)
documentation/ui-user-guide.md (9)
529-529: Correct verb form to match the plural subject.The verb "has" does not agree with the plural subject "tabs".
- The blocking tabs has two sub tabs : + The blocking tabs have two sub tabs :Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~529-~529: The verb form ‘has’ does not seem to match the subject ‘tabs’.
Context: ... the blocking rules. The blocking tabs has two sub tabs : - Linking - Matching ...(SUBJECT_VERB_AGREEMENT_PLURAL)
542-542: Correct modal verb usage.The modal verb "must" is incorrectly followed by "allows" instead of "allow".
- This view must allows the user to do the following : + This view must allow the user to do the following :Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~542-~542: The modal verb ‘must’ requires the verb’s base form.
Context: ...ts/23) Design view This view must allows the user to do the following : - Selec...(MD_BASEFORM)
209-209: Correct the sentence structure for clarity.It appears a word may be missing after 'a', which could lead to confusion.
- a. If no results are found, the system displays a message informing the user that there are no results found. + a. If no results are found, the system displays a message informing the user that no results are available.Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~209-~209: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
86-86: Correct the spelling of "sub-divided."The term "sub-divided" should be spelled as "subdivided" without a hyphen.
- This tab is sub-divided into 3 sections, starting with the right, the Confusion Matrix. + This tab is subdivided into 3 sections, starting with the right, the Confusion Matrix.Likely invalid or redundant comment.
Tools
LanguageTool
[misspelling] ~86-~86: This word is normally spelled as one.
Context: ...d](.gitbook/assets/29.png) This tab is sub-divided into 3 sections, starting with the righ...(EN_COMPOUNDS_SUB_DIVIDED)
520-520: Remove duplicated word 'add'.The word 'add' is repeated in the text, which is likely a typographical error.
- - Add a second row of input fields by selecting the add add icon button + - Add a second row of input fields by selecting the add icon buttonLikely invalid or redundant comment.
Tools
LanguageTool
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
272-272: Add a comma for clarity.A comma should be added to separate clauses and improve the readability of the sentence.
- **Relink a patient interaction** Relinking a patient interaction means that the interaction is not correctly linked to a Golden record and the Admin user wants to relink the interaction to an existing Golden record or create a new Golden record. + **Relink a patient interaction**, Relinking a patient interaction means that the interaction is not correctly linked to a Golden record and the Admin user wants to relink the interaction to an existing Golden record or create a new Golden record.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
242-242: Add a comma before "i.e." for clarity.Consider adding a comma before "i.e." to improve readability and adhere to grammatical norms.
- the full audit trail for the patient is displayed i.e. all the events that occurred on each interaction are displayed. + the full audit trail for the patient is displayed, i.e., all the events that occurred on each interaction are displayed.Likely invalid or redundant comment.
Tools
LanguageTool
[typographical] ~242-~242: Consider putting a comma before the abbreviation “i.e.”.
Context: ...the full audit trail for the patient is displayed i.e. all the events that occurred on each i...(IE_COMMA)
304-304: Correct the preposition usage.The preposition "as" seems more likely in this position for grammatical correctness.
- 5. The system displays the interaction together with the new searched candidate golden record and prompts confirmation of the link. + 5. The system displays the interaction together with the new searched candidate golden record and prompts confirmation as the link.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~304-~304: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
517-519: Correct the spelling of "dropdown" and add periods to "etc."The term "dropdown" should be spelled as one word, and the abbreviation "etc." should always be followed by a period.
- - Select the operator values from a drop down field eg “And” and “Or” - - Select common field values from a drop down field - - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc + - Select the operator values from a dropdown field, e.g., “And” and “Or” + - Select common field values from a dropdown field + - Select comparator function from a dropdown field, e.g., “Exact”, “Low Fuzziness,” etc.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (3)
documentation/user-interface-user-guide.md (3)
Line range hint
209-209: Rephrase the sentence for clarity.The sentence appears to be incomplete. Consider rephrasing it as follows:
- a. If no results are found, the system displays a message informing the user that there are no results found. + If no results are found, the system displays a message informing the user that no results are available.Tools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Line range hint
217-218: Simplify the sentence for clarity.Consider using a shorter alternative to avoid wordiness.
- In order to view the details of a patient, select the relevant row. + To view the details of a patient, select the relevant row.Tools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Line range hint
455-455: Add the missing article.The definite article "the" should be added before "system" for clarity.
- System sends a notification when the input csv file has been created. + The system sends a notification when the input csv file has been created.Tools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- documentation/ui-user-guide.md (1 hunks)
- documentation/user-interface-user-guide.md (1 hunks)
Additional context used
LanguageTool
documentation/user-interface-user-guide.md
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
documentation/ui-user-guide.md
[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...perform filtering instead of blocking. (e.g Find all males in village x) **Similar...(E_G)
[grammar] ~209-~209: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~217-~217: Consider a shorter alternative to avoid wordiness.
Context: ... of a patient, select the relevant row. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~455-~455: Possible missing article found.
Context: ...no.>), Interaction ID and golden ID. - System sends a notification when the input csv...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
documentation/ui-user-guide.md
121-121: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
569-569: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
570-570: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
571-571: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
121-121: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
414-414: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
415-415: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
569-569: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
570-570: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
571-571: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
578-578: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
579-579: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
2-2: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
22-22: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
88-88: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
125-125: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
145-145: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
153-153: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
167-167: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
175-175: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
190-190: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
220-220: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
239-239: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
247-247: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
278-278: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
291-291: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
311-311: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
329-329: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
331-331: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
357-357: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
361-361: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
381-381: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
383-383: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
390-390: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
405-405: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
419-419: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
428-428: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
434-434: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
448-448: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
470-470: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
474-474: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
480-480: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
498-498: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
514-514: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
540-540: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
12-12: null
Images should have alternate text (alt text)(MD045, no-alt-text)
16-16: null
Images should have alternate text (alt text)(MD045, no-alt-text)
20-20: null
Images should have alternate text (alt text)(MD045, no-alt-text)
139-139: null
Images should have alternate text (alt text)(MD045, no-alt-text)
363-363: null
Images should have alternate text (alt text)(MD045, no-alt-text)
388-388: null
Images should have alternate text (alt text)(MD045, no-alt-text)
417-417: null
Images should have alternate text (alt text)(MD045, no-alt-text)
472-472: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (8)
documentation/user-interface-user-guide.md (4)
6-6: Add a comma before "i.e." for clarity.Consider adding a comma before "i.e." to improve readability and adhere to grammatical norms.
- There are 4 main screens i.e. Dashboard, Browse, Notifications and Import. + There are 4 main screens, i.e., Dashboard, Browse, Notifications, and Import.
Line range hint
272-272:Tools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Line range hint
517-519: Consolidate corrections for "dropdown" and "etc."The term "dropdown" should be spelled as one word, and the abbreviation "etc." should always be followed by a period.
- Select the operator values from a drop down field eg "And" and "Or" - Select common field values from a drop down field - Select comparator function from a drop down field eg "Exact", "Low Fuzziness" etc + Select the operator values from a dropdown field, e.g., "And" and "Or" + Select common field values from a dropdown field + Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness," etc.Tools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
Line range hint
520-520: Remove duplicated word "add".The word "add" is repeated in the text, which is likely a typographical error.
- Add a second row of input fields by selecting the add add icon button + Add a second row of input fields by selecting the add icon buttonTools
LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ccur : The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~33-~33: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~59-~59: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...ion. Source ID : The third node denoted e.g Source ID, shows unique common lists e....(E_G)
[uncategorized] ~98-~98: The abbreviation “e.g.” (= for example) requires two periods.
Context: ....g Source ID, shows unique common lists e.g - Source ID list - Biometric ID list(E_G)
documentation/ui-user-guide.md (4)
6-6: Add a comma before "i.e." for clarity.Consider adding a comma before "i.e." to improve readability and adhere to grammatical norms.
- There are 4 main screens i.e. Dashboard, Browse, Notifications and Import. + There are 4 main screens, i.e., Dashboard, Browse, Notifications, and Import.
517-519: Consolidate corrections for "dropdown" and "etc."The term "dropdown" should be spelled as one word, and the abbreviation "etc." should always be followed by a period.
- Select the operator values from a drop down field eg "And" and "Or" - Select common field values from a drop down field - Select comparator function from a drop down field eg "Exact", "Low Fuzziness" etc + Select the operator values from a dropdown field, e.g., "And" and "Or" + Select common field values from a dropdown field + Select comparator function from a dropdown field, e.g., "Exact", "Low Fuzziness," etc.Tools
LanguageTool
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
520-520: Remove duplicated word "add".The word "add" is repeated in the text, which is likely a typographical error.
- Add a second row of input fields by selecting the add add icon button + Add a second row of input fields by selecting the add icon buttonTools
LanguageTool
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
577-577: Correct abbreviation "e.g."The abbreviation "e.g." should have two periods.
- The third node denoted e.g Source ID, shows unique common lists e.g + The third node denoted e.g., Source ID, shows unique common lists e.g.,
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (13)
documentation/user-interface-guide.md (13)
2-74: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Top Navigation** +## Top Navigation -**Understanding the Top Navigation bar** +## Understanding the Top Navigation bar -**Terms and Definitions to get started with understanding JeMPI** +## Terms and Definitions to get started with understanding JeMPITools
LanguageTool
[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...perform filtering instead of blocking. (e.g Find all males in village x) **Similar...(E_G)
Markdownlint
2-2: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
22-22: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
12-12: null
Images should have alternate text (alt text)(MD045, no-alt-text)
16-16: null
Images should have alternate text (alt text)(MD045, no-alt-text)
20-20: null
Images should have alternate text (alt text)(MD045, no-alt-text)
76-124: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Confusion Matrix** +## Confusion Matrix -**Beta F-scores** +## Beta F-scores -**Records and notifications** +## Records and notificationsTools
Markdownlint
121-121: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
121-121: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
88-88: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
119-121: Fix the inconsistent indentation of list items.The indentation of the list items "Open Notifications" and "Closed notifications" is inconsistent. They should be indented properly to align with the parent list item.
Apply this change:
Notifications - Displays total number of notifications split by: -Open Notifications +- Open Notifications - No. of New & Open notifications -Closed notifications +- Closed notifications - No. of Closed notificationsTools
Markdownlint
121-121: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
121-121: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
173-328: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Browse Patients** +## Browse Patients -**Filter by** +## Filter by -**Filter by (Get interactions)** +## Filter by (Get interactions) -**View Details of Patient Interaction** +## View Details of Patient Interaction -**View Patient Interactions and Audit Trail** +## View Patient Interactions and Audit Trail -**Editing a Golden Record** +## Editing a Golden Record -**Relink a patient interaction** +## Relink a patient interaction -**Relink from Patient Interactions screen** +## Relink from Patient Interactions screen -**Changing the threshold** +## Changing the threshold -**Refine Search** +## Refine SearchTools
LanguageTool
[grammar] ~209-~209: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~217-~217: Consider a shorter alternative to avoid wordiness.
Context: ... of a patient, select the relevant row. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~267-~267: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~304-~304: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~306-~306: Possible missing article found.
Context: ...ion is selected, the relink is done and system displays a successful message b. If t...(AI_HYDRA_LEO_MISSING_THE)
Markdownlint
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
175-175: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
190-190: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
220-220: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
239-239: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
247-247: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
278-278: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
291-291: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
311-311: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
217-218: Rephrase the sentence to avoid wordiness.The sentence "In order to view the details of a patient, select the relevant row." is wordy. Consider rephrasing it to be more concise.
Apply this change:
-To view the details of a patient, select the relevant row. -In order to view the details of a patient, select the relevant row. +To view the details of a patient, select the relevant row.Tools
LanguageTool
[style] ~217-~217: Consider a shorter alternative to avoid wordiness.
Context: ... of a patient, select the relevant row. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
267-268: Add the missing preposition "to".The sentence "Select the save option" is missing the preposition "to". It should be "Select the save option to".
Apply this change:
-Select the save option +Select the save option to System displays a successfully saved message.Tools
LanguageTool
[uncategorized] ~267-~267: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
272-277: Add a comma after the introductory phrase.The sentence "Relinking a patient interaction means that the interaction is not correctly linked to a Golden record and the Admin user wants to relink the interaction to an existing Golden record or create a new Golden record." is missing a comma after the introductory phrase "Relinking a patient interaction".
Apply this change:
-Relinking a patient interaction means that the interaction is not correctly linked to a Golden record and the Admin user wants to relink the interaction to an existing Golden record or create a new Golden record. +Relinking a patient interaction, means that the interaction is not correctly linked to a Golden record and the Admin user wants to relink the interaction to an existing Golden record or create a new Golden record.Tools
LanguageTool
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
Markdownlint
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
304-307: Replace "to" with "as" and add the missing article "the".In the sentence "The system displays the interaction together with the new searched candidate golden record and prompts confirmation of the link.", "to" should be replaced with "as" and the article "the" is missing before "system".
Apply this change:
-Select the LINK button on the candidate golden record that you want to link the patient interaction to -The system displays the interaction together with the new searched candidate golden record and prompts confirmation of the link. +Select the LINK button on the candidate golden record that you want to link the patient interaction as +The system displays the interaction together with the new searched candidate golden record and prompts confirmation of the link. a. If the CONFIRM option is selected, the relink is done and the system displays a successful messageTools
LanguageTool
[uncategorized] ~304-~304: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~306-~306: Possible missing article found.
Context: ...ion is selected, the relink is done and system displays a successful message b. If t...(AI_HYDRA_LEO_MISSING_THE)
329-418: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Notifications Worklist** +## Notifications Worklist -**Refine search options** +## Refine search options -**Refine search** +## Refine search -**Review Linked Patient record** +## Review Linked Patient record -**Relink function** +## Relink function -**Create New Golden Record function** +## Create New Golden Record function -**Close Notification** +## Close NotificationTools
LanguageTool
[uncategorized] ~412-~412: Possible missing preposition found.
Context: ...stem displays a confirmation message 4. Select the CONFIRM button. 5. The system: -...(AI_HYDRA_LEO_MISSING_TO)
Markdownlint
414-414: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
415-415: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
329-329: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
331-331: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
357-357: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
361-361: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
381-381: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
383-383: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
390-390: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
405-405: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
363-363: null
Images should have alternate text (alt text)(MD045, no-alt-text)
388-388: null
Images should have alternate text (alt text)(MD045, no-alt-text)
417-417: null
Images should have alternate text (alt text)(MD045, no-alt-text)
414-415: Fix the inconsistent indentation of list items and add the missing preposition "to".The list items "saves and updates the link score to 3.0." and "notification state is updated from New/Open to Closed." are not properly indented. They should be indented to align with the parent list item. Also, the preposition "to" is missing in the sentence "The system:".
Apply this change:
The system: - saves and updates the link score to 3.0. - notification state is updated from New/Open to Closed. + - saves and updates the link score to 3.0. + - notification state is updated from New/Open to Closed.Tools
Markdownlint
414-414: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
415-415: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
419-473: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Machine Learning Configuration** +## Machine Learning Configuration -**Thresholds** +## Thresholds -**Reports** +## Reports -**Fields and Validation - Thresholds** +## Fields and Validation - ThresholdsTools
LanguageTool
[uncategorized] ~455-~455: Possible missing article found.
Context: ...no.>), Interaction ID and golden ID. - System sends a notification when the input csv...(AI_HYDRA_LEO_MISSING_THE)
Markdownlint
419-419: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
428-428: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
434-434: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
448-448: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
470-470: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
472-472: null
Images should have alternate text (alt text)(MD045, no-alt-text)
455-456: Add the missing article "the".The sentence "System sends a notification when the input csv file has been created." is missing the article "the" before "System".
Apply this change:
-System sends a notification when the input csv file has been created. +The system sends a notification when the input csv file has been created.Tools
LanguageTool
[uncategorized] ~455-~455: Possible missing article found.
Context: ...no.>), Interaction ID and golden ID. - System sends a notification when the input csv...(AI_HYDRA_LEO_MISSING_THE)
474-579: Use proper heading tags instead of emphasis for the headings.In this section, emphasis (bold text) is used for some headings instead of proper heading tags. For better accessibility and structure, it is recommended to use heading tags (
#,##, etc.) for the headings.Apply this change throughout the section:
-**Common Properties** +## Common Properties -**The user can do the following:** +## The user can do the following: -**Deterministic** +## Deterministic -**Source view** +## Source view -**Design view** +## Design view -**Blocking** +## Blocking -**Design view** +## Design view -**Probabilistic** +## Probabilistic -**Rules on threshold slider** +## Rules on threshold slider -**Rules on Threshold** +## Rules on Threshold -**Nodes** +## NodesTools
LanguageTool
[uncategorized] ~476-~476: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
[uncategorized] ~490-~490: Possible missing comma found.
Context: ...r : - The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~511-~511: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
569-569: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
570-570: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
571-571: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
569-569: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
570-570: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
571-571: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
578-578: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
579-579: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
474-474: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
480-480: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
498-498: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
514-514: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
540-540: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- documentation/SUMMARY.md (1 hunks)
- documentation/backup-and-restore.md (2 hunks)
- documentation/configuration-user-guide.md (2 hunks)
- documentation/user-interface-guide.md (1 hunks)
Files skipped from review due to trivial changes (1)
- documentation/configuration-user-guide.md
Files skipped from review as they are similar to previous changes (2)
- documentation/SUMMARY.md
- documentation/backup-and-restore.md
Additional context used
LanguageTool
documentation/user-interface-guide.md
[uncategorized] ~47-~47: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...perform filtering instead of blocking. (e.g Find all males in village x) **Similar...(E_G)
[grammar] ~209-~209: A word may be missing after ‘a’.
Context: ...FILTER button to view the results a. If no results are found, the system dis...(THE_SENT_END)
[style] ~217-~217: Consider a shorter alternative to avoid wordiness.
Context: ... of a patient, select the relevant row. In order to view the details of a patient, select t...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~267-~267: Possible missing preposition found.
Context: ... or edit the field value as required 4. Select the save option 5. System displays a su...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~272-~272: Possible missing comma found.
Context: ...ved message](.gitbook/assets/46.png) Relink a patient interaction Relinking a pa...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~304-~304: The preposition ‘as’ seems more likely in this position.
Context: ...ou want to link the patient interaction to 5. The system displays the interaction ...(AI_HYDRA_LEO_REPLACE_TO_AS)
[uncategorized] ~306-~306: Possible missing article found.
Context: ...ion is selected, the relink is done and system displays a successful message b. If t...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~412-~412: Possible missing preposition found.
Context: ...stem displays a confirmation message 4. Select the CONFIRM button. 5. The system: -...(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~455-~455: Possible missing article found.
Context: ...no.>), Interaction ID and golden ID. - System sends a notification when the input csv...(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~476-~476: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
[uncategorized] ~490-~490: Possible missing comma found.
Context: ...r : - The colour of the row changes to white The edit icon changes to show a save i...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~511-~511: The preposition ‘to’ seems more likely in this position.
Context: ...iew tab (If there are no existing rules on display) 
[uncategorized] ~517-~517: The noun “dropdown” is spelled as one word.
Context: ...g : - Select the operator values from a drop down field eg “And” and “Or” - Select common...(LOCKDOWN)
[uncategorized] ~518-~518: The noun “dropdown” is spelled as one word.
Context: ...Or” - Select common field values from a drop down field - Select comparator function from...(LOCKDOWN)
[uncategorized] ~519-~519: The noun “dropdown” is spelled as one word.
Context: ...eld - Select comparator function from a drop down field eg “Exact”, “Low Fuzziness” etc -...(LOCKDOWN)
[style] ~519-~519: In American English, abbreviations like “etc.” require a period.
Context: ... down field eg “Exact”, “Low Fuzziness” etc - Add a second row of input fields by s...(ETC_PERIOD)
[duplication] ~520-~520: Possible typo: you repeated a word
Context: ...nd row of input fields by selecting the add add icon button - Save rule by selecting th...(ENGLISH_WORD_REPEAT_RULE)
Markdownlint
documentation/user-interface-guide.md
121-121: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
569-569: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
570-570: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
571-571: Expected: 0; Actual: 1
Inconsistent indentation for list items at the same level(MD005, list-indent)
121-121: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
414-414: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
415-415: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
569-569: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
570-570: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
571-571: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
578-578: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
579-579: Expected: 0; Actual: 3
Unordered list indentation(MD007, ul-indent)
2-2: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
4-4: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
22-22: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
76-76: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
88-88: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
103-103: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
114-114: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
118-118: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
125-125: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
132-132: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
145-145: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
153-153: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
167-167: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
173-173: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
175-175: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
190-190: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
194-194: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
212-212: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
220-220: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
239-239: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
247-247: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
272-272: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
278-278: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
291-291: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
311-311: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
329-329: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
331-331: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
357-357: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
361-361: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
381-381: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
383-383: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
390-390: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
405-405: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
419-419: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
428-428: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
434-434: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
448-448: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
470-470: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
474-474: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
480-480: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
498-498: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
514-514: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
540-540: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
12-12: null
Images should have alternate text (alt text)(MD045, no-alt-text)
16-16: null
Images should have alternate text (alt text)(MD045, no-alt-text)
20-20: null
Images should have alternate text (alt text)(MD045, no-alt-text)
139-139: null
Images should have alternate text (alt text)(MD045, no-alt-text)
363-363: null
Images should have alternate text (alt text)(MD045, no-alt-text)
388-388: null
Images should have alternate text (alt text)(MD045, no-alt-text)
417-417: null
Images should have alternate text (alt text)(MD045, no-alt-text)
472-472: null
Images should have alternate text (alt text)(MD045, no-alt-text)
Additional comments not posted (1)
documentation/user-interface-guide.md (1)
476-477: Replace "the" with "they".In the sentence "the best fit the desired implementation of the MPI.", "the" should be
Tools
LanguageTool
[uncategorized] ~476-~476: “the” seems less likely than “they”.
Context: ...to make edits to the default settings, the best fit the desired implementation of ...(AI_HYDRA_LEO_CP_THE_THEY)
MatthewErispe
deleted the
CU-86c060qh5_Documentation-Add-user-guide-for-UI
branch
Summary by CodeRabbit