-
Notifications
You must be signed in to change notification settings - Fork 376
Fixed grammar, punctuation, and typos in quick-start-guide.md #5784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
|
Manoja Somarathna seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
WalkthroughA documentation file receives copyediting refinements including grammar corrections, punctuation adjustments, terminology normalization (e.g., "userstores" to "user stores"), hyphenation improvements, and a privacy law acronym correction ("LGDP" to "LGPD"). Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
en/identity-server/7.0.0/docs/get-started/quick-start-guide.md (1)
33-33: Consider removing hyphen from "OAuth-related" per repository style preference.The change introduces "OAuth-related standards" (hyphenated). However, retrieved learnings from the repository indicate a preference for unhyphenated compound adjectives in this documentation (e.g., "SCIM API compliant", "Admin initiated profile update") for better readability and natural flow.
Consider revising to "OAuth related standards" (unhyphenated) to align with the established repository style.
Apply this diff if the repository style preference should be observed:
-It supports open standards such as OAuth, OpenID Connect and SAML 2.0. It also enables high availability, failover, and performance for smooth operation. +It supports open standards such as OAuth, OpenID Connect and SAML 2.0. It also enables high availability, failover, and performance for smooth operation.Alternatively, if you'd like to confirm the repository's current style direction on compound adjectives, please search for similar patterns (e.g., "API related", "token related") in recent merged PRs.
[Based on learnings, this recommendation is derived from PR 5732 guidance on preferring unhyphenated compound adjectives in this repository.]
Also applies to: 39-39
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/identity-server/7.0.0/docs/get-started/quick-start-guide.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Thisara-Welmilla
Repo: wso2/docs-is PR: 5732
File: en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-profile-action-v1.x.md:273-273
Timestamp: 2025-12-01T15:31:14.922Z
Learning: In the wso2/docs-is repository documentation files, prefer unhyphenated compound adjectives (e.g., "SCIM API compliant", "Admin initiated profile update") over hyphenated versions for better readability and natural flow.
📚 Learning: 2025-12-01T15:31:14.922Z
Learnt from: Thisara-Welmilla
Repo: wso2/docs-is PR: 5732
File: en/includes/guides/service-extensions/pre-flow-extensions/action-versions/pre-update-profile-action-v1.x.md:273-273
Timestamp: 2025-12-01T15:31:14.922Z
Learning: In the wso2/docs-is repository documentation files, prefer unhyphenated compound adjectives (e.g., "SCIM API compliant", "Admin initiated profile update") over hyphenated versions for better readability and natural flow.
Applied to files:
en/identity-server/7.0.0/docs/get-started/quick-start-guide.md
🔇 Additional comments (3)
en/identity-server/7.0.0/docs/get-started/quick-start-guide.md (3)
29-29: Comma placement is correct.The addition of the comma before the participial phrase "making life easier" improves sentence clarity and readability.
33-33: Verify comma before "etc." in list.The text shows "FIDO Passkeys etc." without a comma before "etc." However, the PR objectives specify this should be changed to "passkeys, etc." (with comma). Please confirm whether a comma should be added before "etc." for consistency with formal list punctuation conventions.
35-35: Copyediting refinements look good.The following changes are correct and improve clarity:
- Line 35: Removed unnecessary comma from list ("view and manage")
- Line 37: Normalized "userstores" to "user stores" (two words)
- Line 39: Removed indefinite article ("for smooth operation" vs. "for a smooth operation")
- Line 42: Corrected privacy law acronym ("LGDP" → "LGPD")
Also applies to: 37-37, 39-39, 42-42
|
git commit -m "Fixed grammar, punctuation, and typos in quick-start-guide.md" |
|
"Please review and approve this PR" |
Spelling
userstores → user stores
OAuth related → OAuth-related (hyphen)
LGDP → LGPD
"passkeys etc" → passkeys, etc.
Grammar
adaptive authentication which means → adaptive authentication, which means
user device → user’s device
let users view, and manage → comma
for a smooth operation → for smooth operation
Formatting / consistency
Hyphen double space
Comma
…for each application making life easier… → comma for each application, making life easier…
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.