Fix grammar and readability in employee identity docs#5998
Open
Ayoraaaa wants to merge 2 commits intowso2:masterfrom
Open
Fix grammar and readability in employee identity docs#5998Ayoraaaa wants to merge 2 commits intowso2:masterfrom
Ayoraaaa wants to merge 2 commits intowso2:masterfrom
Conversation
Fixed grammatical errors:
- implanted → implemented
- identifies → identities
- relogin → log in again
- increase → increases
- Corrected spelling: on-boarding → onboarding
- Improved bullet formatting for MFA and other lists
- Removed trailing spaces and extra line breaks
- Left {{product_name}} placeholders intact
Contributor
WalkthroughEditorial updates to the Workforce IAM documentation: grammatical fixes, punctuation and phrasing polishing, terminology standardization, and reorganization of MFA/authentication bullets. No functional or API changes were made. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip CodeRabbit can generate a title for your PR based on the changes.Add |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/concepts/workforce-iam.md`:
- Line 27: Remove the unintended leading whitespace at the start of the sentence
in en/includes/concepts/workforce-iam.md so the line beginning "Eliminate the
need for passwords and offer secure passwordless authentication for your
workforce using Magic Link, Passkeys, biometrics and Email/SMS OTPs." starts
flush with no leading space; edit that line to remove the extra space and ensure
markdown renders cleanly.
- Line 71: Update the user-facing sentence that currently reads "Allow users to
login with multiple login identities" in the workforce-iam.md content to use the
correct verb form: change "login" to "log in" so the line reads "Allow users to
log in with multiple login identities"; ensure any other occurrences in the same
file follow this same "log in" verb form for consistency.
- Line 5: Replace the incorrect user-action phrasing "login in again" with the
correct verb phrase "log in again" in the sentence about Enterprise
Single-Sign-On; also scan the surrounding text for other usages and standardize
to "log in" for the action and reserve "login" for the noun (e.g., "a login") to
keep terminology consistent within the document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 8fb060ff-cf83-4dc3-9cd7-84983a195187
📒 Files selected for processing (1)
en/includes/concepts/workforce-iam.md
|
|
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
en/includes/concepts/workforce-iam.md (1)
15-15: Split this into shorter, active-voice sentences.Line 15 is hard to parse and uses passive phrasing (“can be implemented”). Please rewrite in shorter sentences and address the reader directly.
✏️ Suggested rewrite
-Automate and create unified onboarding experiences for your workforce by integrating various onboarding channels such as HRM systems, existing AD and LDAP directories with {{product_name}} to create a unified view of your workforce that enables centralized workforce management. Different provisioning and deprovisioning policies can be implemented as per workforce variance based on their employment such as full-time, contractual and outsourced and based on their job roles. +Integrate onboarding channels such as HRM systems and existing AD and LDAP directories with {{product_name}} to create a unified workforce view. This lets you manage workforce identities centrally. You can then apply different provisioning and deprovisioning policies based on employment type (full-time, contractual, or outsourced) and job role.As per coding guidelines, "
**/*.md: Use active voice and present tense; ... Use plain language and short sentences; Address the reader as 'you'".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/concepts/workforce-iam.md` at line 15, Rewrite the long sentence into 2–4 short, active sentences that address the reader as "you" and use present tense; mention integrating HRM systems, AD/LDAP directories, and {{product_name}} separately, then state that you create a unified workforce view for centralized management, and finally say that you can implement different provisioning and deprovisioning policies for full-time, contract, and outsourced roles based on job role—avoid passive phrasing like "can be implemented" and keep each sentence simple and direct.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/includes/concepts/workforce-iam.md`:
- Line 27: Trim the trailing whitespace at the end of the line containing
"Eliminate the need for passwords and offer secure passwordless authentication
for your workforce using Magic Link, Passkeys, biometrics and Email/SMS OTPs."
so the line ends immediately after "OTPs." and re-run Vale locally to ensure no
remaining warnings; commit the cleaned line.
- Line 40: Update the compound modifiers in the workforce-iam content to use
hyphens for readability: change "ready to use templates" to "ready-to-use
templates" and similarly hyphenate phrases like "OpenID Connect supported" →
"OpenID Connect-supported" and "SAML 2.0 supported" → "SAML 2.0-supported";
apply the same hyphenation to the repeated instances referenced (lines ~59-60)
and ensure sentences remain short and plain per the style guidelines.
---
Nitpick comments:
In `@en/includes/concepts/workforce-iam.md`:
- Line 15: Rewrite the long sentence into 2–4 short, active sentences that
address the reader as "you" and use present tense; mention integrating HRM
systems, AD/LDAP directories, and {{product_name}} separately, then state that
you create a unified workforce view for centralized management, and finally say
that you can implement different provisioning and deprovisioning policies for
full-time, contract, and outsourced roles based on job role—avoid passive
phrasing like "can be implemented" and keep each sentence simple and direct.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 4c84a2b6-c020-4a0c-a174-f271fe56a9af
📒 Files selected for processing (1)
en/includes/concepts/workforce-iam.md
| Secure user accounts of your workforce and business applications by enforcing MFA options. {{product_name}} offers secure MFA options including SMS and Email OTP, TOTP using authenticator apps, FIDO-based Passkeys, Duo-based push notifications and hardware tokens and facial biometrics such as iProov. | ||
|
|
||
| Get rid of passwords completely and offer secure passwordless authentication for your workforce using Magic Link, Passkeys, biometrics and Email/SMS OTPs. | ||
| Eliminate the need for passwords and offer secure passwordless authentication for your workforce using Magic Link, Passkeys, biometrics and Email/SMS OTPs. |
Contributor
There was a problem hiding this comment.
Remove trailing whitespace at end of line.
Line 27 ends with extra spaces. Please trim trailing whitespace to keep markdown clean and avoid noisy diffs.
As per coding guidelines, "Run Vale locally and resolve all warnings before finalizing documentation".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/concepts/workforce-iam.md` at line 27, Trim the trailing
whitespace at the end of the line containing "Eliminate the need for passwords
and offer secure passwordless authentication for your workforce using Magic
Link, Passkeys, biometrics and Email/SMS OTPs." so the line ends immediately
after "OTPs." and re-run Vale locally to ensure no remaining warnings; commit
the cleaned line.
| {{product_name}} automatically configures a default login flow for you to get started. You can design your desired login flow by adding social providers or MFA options using {{product_name}}'s visual login flow designer, where you can drag and drop the required elements. Alternatively, you can use the Login Flow AI feature to generate the desired login flow based on your plain text instructions. | ||
|
|
||
| Make workforce authentication adaptive by adjusting authentication options such as adaptive MFA , adaptive access control and passkey enrollment as per the current risk level assessed using contextual parameters such as location, device and behavior. {{product_name}} offers a set of ready to use templates that can be configured for your workforce requirements and you can also develop your own adaptive authentication scripts. | ||
| Make workforce authentication adaptive by adjusting authentication options such as adaptive MFA, adaptive access control and passkey enrollment as per the current risk level assessed using contextual parameters such as location, device and behavior. {{product_name}} offers a set of ready to use templates that can be configured for your workforce requirements and you can also develop your own adaptive authentication scripts. |
Contributor
There was a problem hiding this comment.
Hyphenate compound modifiers for readability.
Use hyphens in compound modifiers before nouns: ready-to-use, OpenID Connect-supported, and SAML 2.0-supported.
✏️ Suggested edits
-Make workforce authentication adaptive by adjusting authentication options such as adaptive MFA, adaptive access control and passkey enrollment as per the current risk level assessed using contextual parameters such as location, device and behavior. {{product_name}} offers a set of ready to use templates that can be configured for your workforce requirements and you can also develop your own adaptive authentication scripts.
+Make workforce authentication adaptive by adjusting authentication options such as adaptive MFA, adaptive access control, and passkey enrollment based on the current risk level assessed using contextual parameters such as location, device, and behavior. {{product_name}} offers a set of ready-to-use templates that you can configure for your workforce requirements, and you can also develop your own adaptive authentication scripts.-- Configure SSO for OpenID Connect supported applications
-- Configure SSO for SAML 2.0 supported applications
+- Configure SSO for OpenID Connect-supported applications
+- Configure SSO for SAML 2.0-supported applicationsAs per coding guidelines, "Use plain language and short sentences" and "Run Vale locally and resolve all warnings before finalizing documentation".
Also applies to: 59-60
🧰 Tools
🪛 LanguageTool
[grammar] ~40-~40: Use a hyphen to join words.
Context: .... {{product_name}} offers a set of ready to use templates that can be configured ...
(QB_NEW_EN_HYPHEN)
[grammar] ~40-~40: Use a hyphen to join words.
Context: ...{product_name}} offers a set of ready to use templates that can be configured for...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/concepts/workforce-iam.md` at line 40, Update the compound
modifiers in the workforce-iam content to use hyphens for readability: change
"ready to use templates" to "ready-to-use templates" and similarly hyphenate
phrases like "OpenID Connect supported" → "OpenID Connect-supported" and "SAML
2.0 supported" → "SAML 2.0-supported"; apply the same hyphenation to the
repeated instances referenced (lines ~59-60) and ensure sentences remain short
and plain per the style guidelines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixed grammatical errors:
Purpose
This PR improves the employee identity documentation by fixing grammar and formatting issues to enhance readability and maintain consistency across the docs. No functional changes were made to the content.
Related PRs
None
Test environment
Tested on GitHub Markdown preview.
Security checks
Summary by CodeRabbit