Docs/end to end onboarding staff user docs #858
Conversation
|
Warning Rate limit exceeded@landonshumway-ia has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 25 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughA new onboarding guide for Compact Connect administrative staff has been added. The documentation provides detailed instructions for initial setup, user management, system configuration, license data handling, privilege management, and support contact information, aimed at facilitating the onboarding process for both compact and state staff users. Changes
Sequence Diagram(s)sequenceDiagram
participant StaffUser
participant System
participant Admin
participant Support
StaffUser->>System: Receive credentials & login
System-->>StaffUser: Prompt to change password
StaffUser->>System: Access dashboard
Admin->>System: Invite new users / manage permissions
StaffUser->>System: Search/view practitioner/license data
Admin->>System: Configure system settings & fees
StaffUser->>Support: Contact for assistance
Assessment against linked issues
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
staff-user-documentation/README.md (4)
49-49: Remove trailing colons from headingsSeveral headings end with
:(e.g., "Steps to Invite Users:", "Available Permissions:", "Available Information:", "Steps to Deactivate a Privilege:", "Steps to Add an Encumbrance:"). Remove these trailing colons for markdown consistency.Also applies to: 64-64, 289-289, 330-330, 345-345
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
49-49: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
66-74: Use proper heading levels for permission labelsThe permission names (
**Read Private**,**Read SSN**,**Admin**) are styled as bold text but function as subheadings. Convert them into actual markdown subheadings (e.g.##### Read Private) for better structure.🧰 Tools
🪛 LanguageTool
[style] ~72-~72: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ... permission should only be granted when absolutely required for job responsibilities Admin - M...(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
🪛 markdownlint-cli2 (0.17.2)
66-66: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
74-74: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
82-84: Convert "Write" permission label into a headingSimilarly, the
**Write** *(State-level only)*label should be a subheading (e.g.,##### Write (State-level only)) instead of bold text.
70-73: Shorten phrasing for clarityReplace "absolutely required" with a more concise term, e.g.:
- ⚠️ **Critical**: This permission should only be granted when absolutely required for job responsibilities + ⚠️ **Critical**: Grant this permission only when necessary for job responsibilities🧰 Tools
🪛 LanguageTool
[style] ~72-~72: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ... permission should only be granted when absolutely required for job responsibilities Admin - M...(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
🪛 markdownlint-cli2 (0.17.2)
70-70: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
staff-user-documentation/images/invite_user_form.pngis excluded by!**/*.pngstaff-user-documentation/images/license_list_view.pngis excluded by!**/*.pngstaff-user-documentation/images/license_search_tab.pngis excluded by!**/*.pngstaff-user-documentation/images/license_upload.pngis excluded by!**/*.pngstaff-user-documentation/images/manage_users_tab.pngis excluded by!**/*.pngstaff-user-documentation/images/practitioner_details_page.pngis excluded by!**/*.pngstaff-user-documentation/images/privilege_action_menu.pngis excluded by!**/*.pngstaff-user-documentation/images/privilege_summary.pngis excluded by!**/*.pngstaff-user-documentation/images/reset_password.pngis excluded by!**/*.pngstaff-user-documentation/images/settings_tab.pngis excluded by!**/*.pngstaff-user-documentation/images/staff_login.pngis excluded by!**/*.pngstaff-user-documentation/images/user_management_page.pngis excluded by!**/*.png
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
staff-user-documentation/README.md
[style] ~72-~72: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ... permission should only be granted when absolutely required for job responsibilities Admin - M...
(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
[style] ~180-~180: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all participating jurisdictions. #### Compact Administration Fee The Compact Adminis...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
49-49: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
64-64: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
66-66: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
74-74: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
209-209: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
212-212: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
215-215: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
289-289: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
330-330: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
345-345: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (1)
staff-user-documentation/README.md (1)
311-312: Verify relative link to backend documentationConfirm that the link
[License Data Schema Documentation](../backend/compact-connect/docs/README.md)correctly points to the intended file path in the repo.
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
staff-user-documentation/README.md (1)
365-365:⚠️ Potential issueAdd Support and Contact Information section
The guide’s summary mentions support contact details, but there’s no dedicated section in the document. Append a “Support and Contact Information” section at the end to provide users with help resources.
♻️ Duplicate comments (1)
staff-user-documentation/README.md (1)
5-12: Add missing TOC entry for Support and Contact Information
The table of contents currently lists most sections but doesn't include the final Support and Contact Information heading.
🧹 Nitpick comments (5)
staff-user-documentation/README.md (5)
70-74: Reduce wordiness
Replace “absolutely required” with “required” for conciseness:- ⚠️ **Critical**: This permission should only be granted when absolutely required for job responsibilities + ⚠️ **Critical**: This permission should only be granted when required for job responsibilities🧰 Tools
🪛 LanguageTool
[style] ~72-~72: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ... permission should only be granted when absolutely required for job responsibilities Admin - M...(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
🪛 markdownlint-cli2 (0.17.2)
70-70: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
74-74: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
269-272: Add missing article
Insert “the” before “dropdown menu” and streamline the filter clause:- **State/Jurisdiction**: Select from dropdown menu. This will filter the results to only display practitioners... + **State/Jurisdiction**: Select from the dropdown menu. This will filter the results to display practitioners...🧰 Tools
🪛 LanguageTool
[uncategorized] ~269-~269: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
289-289: Remove trailing punctuation in heading
Headings should not end with a colon.- #### Available Information: + #### Available Information🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
289-289: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
290-292: Fix typo in “Privileges and their current statis”
Change “statis” to “status” for correct spelling:- - Privileges and their current statis + - Privileges and their current status
130-231: Standardize section headings
Throughout the System Configuration and Compact Administrator Settings sections, emphasis (e.g.,**Compact Administration Fee**) is used in place of proper headings. For better structure and accessibility, convert these to Markdown heading levels that reflect the document hierarchy.🧰 Tools
🪛 LanguageTool
[style] ~180-~180: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all participating jurisdictions. #### Compact Administration Fee The Compact Adminis...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
130-130: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
184-184: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
198-198: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
209-209: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
212-212: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
215-215: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
231-231: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
staff-user-documentation/README.md
[style] ~72-~72: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ... permission should only be granted when absolutely required for job responsibilities Admin - M...
(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
[style] ~180-~180: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all participating jurisdictions. #### Compact Administration Fee The Compact Adminis...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~269-~269: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
66-66: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
70-70: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
74-74: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
130-130: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
184-184: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
198-198: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
209-209: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
212-212: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
215-215: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
231-231: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
289-289: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
staff-user-documentation/README.md (1)
5-12: Add missing TOC entry for the Support and Contact Information section
The guide includes a Support and Contact Information section (per PR description), but it isn’t listed in the Table of Contents. Please add:
🧹 Nitpick comments (3)
staff-user-documentation/README.md (3)
18-23: Ensure consistent bullet formatting in invitation details
The invitation details list uses hyphens alongside nested numbers; aligning on a single bullet style and indentation level will improve readability.
60-83: Convert bolded role labels to subheadings for clarity
Within the Permissions section, inline bolding for Compact Admins and State Admins can be hard to scan. Turning these into#### Compact Admins/#### State Adminssubheadings will enhance navigation.
136-142: Reword repetitive sentences
The Military Rate Configuration steps begin multiple sentences with “Enable” or “Set.” Consider combining or varying sentence starters to avoid repetition, e.g.:“Enable the Military Rate option, then specify the reduced fee amount for qualifying personnel.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
staff-user-documentation/README.md
[style] ~180-~180: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all participating jurisdictions. #### Compact Administration Fee The Compact Adminis...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
130-130: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
184-184: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
198-198: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
209-209: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
212-212: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
215-215: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
231-231: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
289-289: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (3)
staff-user-documentation/README.md (3)
1-4: Approve introductory section
The title and introduction clearly state the guide’s purpose and audience.
365-365: Inconsistent summary: missing Support section
The PR description and AI summary reference a “Support and Contact Information” section, but it’s not present in this snippet. Please confirm if it’s included later or update the summary accordingly.Likely an incorrect or invalid review comment.
309-313:✅ Verification successful
Verify link to License Data Schema Documentation
Please confirm that../backend/compact-connect/docs/README.mdcorrectly resolves to the schema docs location. Run:
🏁 Script executed:
#!/bin/bash # Verify that the license data schema documentation exists if [ ! -f backend/compact-connect/docs/README.md ]; then echo "ERROR: backend/compact-connect/docs/README.md not found" exit 1 fi echo "✅ Schema documentation path verified."Length of output: 140
Schema documentation link verified
The relative path../backend/compact-connect/docs/README.mdcorrectly points to the License Data Schema Documentation. No changes needed.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
staff-user-documentation/README.md (1)
5-12: Add missing TOC entry for Support sectionThe final "Support and Contact Information" section isn't listed in the Table of Contents.
Apply:@@ -11,6 +12,7 @@ - [Privilege and License Management](#privilege-and-license-management) +- [Support and Contact Information](#support-and-contact-information)
🧹 Nitpick comments (4)
staff-user-documentation/README.md (4)
130-134: Convert "Configuration Steps" to a headingUse a Markdown heading (e.g.,
#### Configuration Steps) instead of bold text for better structure and navigation:-**Configuration Steps** +#### Configuration Steps🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
130-130: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
147-153: Elevate notification recipient labels to subheadingsTransition the bolded list items into headings for consistency:
-**1. Operations Notification Recipients** +#### Operations Notification Recipients🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
147-147: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
268-270: Add missing article in sentenceInsert "the" before "dropdown menu" for grammatical correctness:
-**State/Jurisdiction**: Select from dropdown menu. +**State/Jurisdiction**: Select from the dropdown menu.🧰 Tools
🪛 LanguageTool
[uncategorized] ~269-~269: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
289-289: Remove trailing colon in headingAvoid trailing punctuation in headings:
-#### Available Information: +#### Available Information🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
289-289: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
staff-user-documentation/README.md
[style] ~180-~180: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... all participating jurisdictions. #### Compact Administration Fee The Compact Adminis...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~269-~269: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
130-130: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
147-147: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
150-150: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
153-153: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
184-184: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
198-198: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
209-209: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
212-212: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
215-215: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
231-231: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
289-289: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (2)
staff-user-documentation/README.md (2)
364-365:⚠️ Potential issueDocument missing "Support and Contact Information" section
The guide ends without the section for user support details described in the summary. Include a new section at the end with contact emails, phone numbers, and escalation paths.
Likely an incorrect or invalid review comment.
64-74: Permission labels formatted correctlyGood use of heading levels (
#####) for permission names, enhancing navigation.
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
staff-user-documentation/README.md (1)
394-397:⚠️ Potential issueInclude the Support and Contact Information section
The documentation mentions support contacts but no corresponding section is present. Add a final section with support channels, response SLAs, and escalation paths, for example:## Support and Contact Information For assistance, please contact: - **Email:** [email protected] - **Phone:** 1-800-CC-SUPPORT - **Portal:** https://support.compactconnect.org
🧹 Nitpick comments (3)
staff-user-documentation/README.md (3)
291-292: Insert missing article “the”
Change “Select from dropdown menu” to “Select from the dropdown menu” for grammatical accuracy.🧰 Tools
🪛 LanguageTool
[uncategorized] ~292-~292: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
148-154: Convert emphasized notification labels into headings
Using bold for notification recipients hinders navigation. Replace:**1. Operations Notification Recipients**with a heading level, e.g.:
#### Operations Notification RecipientsApply this pattern to all three lists in both the State and Compact admin sections.
Also applies to: 232-238
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
148-148: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
151-151: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
154-154: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
312-312: Remove trailing colon from heading
The heading#### Available Information:should drop the colon:#### Available Informationto comply with heading style guidelines.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
312-312: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
staff-user-documentation/images/authorize_net_home_settings.pngis excluded by!**/*.pngstaff-user-documentation/images/authorize_net_settings_eccv.pngis excluded by!**/*.pngstaff-user-documentation/images/eccv_filter_settings.pngis excluded by!**/*.png
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
staff-user-documentation/README.md
[uncategorized] ~292-~292: You might be missing the article “the” here.
Context: ...: - State/Jurisdiction: Select from dropdown menu. This will filter the results to o...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
131-131: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
148-148: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
151-151: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
154-154: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
185-185: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
207-207: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
221-221: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
232-232: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
235-235: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
238-238: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
254-254: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
312-312: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
| ## Table of Contents | ||
| - [Initial Setup and Login](#initial-setup-and-login) | ||
| - [User Management](#user-management) | ||
| - [System Configuration](#system-configuration) | ||
| - [General User Functions](#general-user-functions) | ||
| - [Data Upload](#data-upload) | ||
| - [Automated License Data Upload for IT Departments](#automated-license-data-upload-for-it-departments) | ||
| - [Privilege and License Management](#privilege-and-license-management) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add “Support and Contact Information” to the TOC
The table of contents currently ends at Privilege and License Management but the guide references support contacts. Please include:
- [Support and Contact Information](#support-and-contact-information)to ensure readers can jump directly to that section.
🤖 Prompt for AI Agents
In staff-user-documentation/README.md around lines 5 to 13, the Table of
Contents is missing the "Support and Contact Information" entry. Add the line "-
[Support and Contact Information](#support-and-contact-information)" at the end
of the TOC list to allow readers to navigate directly to that section.
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
staff-user-documentation/README.md (1)
398-399: Add the Support and Contact Information sectionInclude a new section at the end of the document with real contact details for users needing assistance. For example:
--- +## Support and Contact Information + +For additional help or to report issues, please contact Compact Connect Support: +- **Email**: [email protected] +- **Phone**: 1-800-COMPACT +- **Hours**: Mon–Fri, 8 AM–6 PM ET
♻️ Duplicate comments (1)
staff-user-documentation/README.md (1)
5-13: Add “Support and Contact Information” to the TOCThe guide references contacting support at the end but there is no matching section or TOC entry. Please add an entry here:
- [Privilege and License Management](#privilege-and-license-management) + - [Support and Contact Information](#support-and-contact-information)
🧹 Nitpick comments (5)
staff-user-documentation/README.md (5)
131-135: Convert “Configuration Steps” to a proper subheadingUsing bold for a subheading breaks document structure and TOC auto-generation. Change:
-**Configuration Steps** +##### Configuration Steps
148-154: Convert notification list items into subheadingsReplace the bold-numbered items under State admin “Contact Details for System Notifications” with markdown headings. For example:
-**1. Operations Notification Recipients** +##### Operations Notification Recipients -**2. Encumbrance Notification Recipients** +##### Encumbrance Notification Recipients -**3. Summary Report Notification Recipients** +##### Summary Report Notification Recipients
232-238: Convert notification list items into subheadingsSimilarly update the Compact admin section’s notification items:
-**1. Operations Notification Recipients** +##### Operations Notification Recipients -**2. Encumbrance Notification Recipients** +##### Encumbrance Notification Recipients -**3. Summary Report Notification Recipients** +##### Summary Report Notification Recipients
312-312: Remove trailing colon in headingHeadings should not end with punctuation. Update:
-#### Available Information: +#### Available Information
313-315: Fix typo in “Privileges and their current statis”Correct the spelling of “statis”:
-- Privileges and their current statis +- Privileges and their current status
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
staff-user-documentation/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
staff-user-documentation/README.md
131-131: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
148-148: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
151-151: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
154-154: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
185-185: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
207-207: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
221-221: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
232-232: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
235-235: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
238-238: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
254-254: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
312-312: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
|
@jlkravitz This is ready for your review. Thanks |
This adds a comprehensive guide to using the compact connect system, which we can link our beta users to so they know how to use/test the system as we onboard compact/state staff users.
Closes #825
Summary by CodeRabbit