Fix typos and grammar errors across documentation - #55
Merged
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (21)
📝 WalkthroughWalkthroughThis pull request consolidates 42 documentation fixes across the healthcare accelerator guides under the Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
en/docs/fhir/guides/populating-fhir-resources.md (1)
28-32:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix the Ballerina FHIR package import typo in the guide snippet.
Line ~28 references
ballerinax/health.fhir.r4.international401, but the code block at line ~31 importsballerinax/health.fhir.r4.internationa401(missingl). Update the import in the snippet toballerinax/health.fhir.r4.international401.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@en/docs/fhir/guides/populating-fhir-resources.md` around lines 28 - 32, The code snippet import has a typo: change the package import in the fenced Ballerina snippet from "ballerinax/health.fhir.r4.internationa401" to the correct "ballerinax/health.fhir.r4.international401" so it matches the intended FHIR IG package name referenced in the text; update the import line in the snippet accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/data-transformation/guides/hl7v2-fhir.md`:
- Around line 223-227: Rewrite the two sentences for clarity and hyphenation:
change "openapi files as below" to "the OpenAPI file below" and "auto generated"
to "auto-generated", so the first line reads like "Generate the files using the
OpenAPI file below:" (keeping the bal CLI invocation "bal openapi -i
resources/custom-service-openapi.yaml --mode service -o <OUTPUT-FOLDER>") and
the second line reads like "The types.bal file is auto-generated into the
specified folder and does not require any changes." Ensure consistent
capitalization of "OpenAPI" and keep references to the bal command and types.bal
unchanged.
In `@en/docs/fhir/guides/connecting-ehr-emr-systems.md`:
- Around line 21-22: The markdown link text "[link]" under the "Install the
connector" section is too generic—replace it with a descriptive label such as
"WSO2 connector usage guide" (or similar) so readers know what the link points
to; update the inline markdown link where "[link]" appears to use the new
descriptive text while keeping the same URL and surrounding punctuation.
In `@en/docs/fhir/guides/expose-fhir-apis.md`:
- Line 61: Change the un-hyphenated compound modifier "Instance level" to
"Instance-level" and any occurrences of "instance level interactions" to
"instance-level interactions" in the sentence that reads "Instance level - All
the instance level interactions are pre-templated..." so the phrasing becomes
"Instance-level - All the instance-level interactions are pre-templated..." to
ensure consistent compound-modifier hyphenation.
In `@en/docs/get-started/architecture.md`:
- Line 42: Update the sentence that currently reads "FHIR defines a RESTful API
interface to any FHIR resource" to remove the redundant word "interface" and
hyphenate "3.0 based" to "3.0-based"; specifically change the phrase to
something like "FHIR defines a RESTful API to any FHIR resource. We built
another tool to automatically generate the OpenAPI Specification 3.0-based API
definition files for any FHIR profile or an implementation guide." Target the
sentence containing "FHIR defines a RESTful API interface to any FHIR resource"
and the phrase "Open API Specification 3.0 based API definition files" for these
edits.
In `@en/docs/get-started/introduction.md`:
- Line 4: The frontmatter "description" value and the opening sentence in the
body are grammatically incorrect and unclear; update both to a concise, clear
sentence such as: "WSO2 Open Healthcare is an open-source integration platform
for healthcare systems." Replace the existing frontmatter description and the
corresponding opening sentence in the document body with this wording (look for
the frontmatter key description and the document's first paragraph/opening
sentence).
In `@en/docs/install-and-setup/updates/overview.md`:
- Around line 15-16: The two sentences shown ("A subscription is mandatory to
get WSO2 updates." and "A Subscription can be obtained by different ways and
there are different types of subscription tiers available.") are awkward and
redundant—replace them with a concise, consistent phrasing such as: "A
subscription is required to receive WSO2 updates; subscriptions are available in
multiple tiers and can be obtained in several ways." Apply the same clarity and
consistency to the similar text at the other occurrences (lines referenced 22-23
and 26) so all subscription guidance uses the same concise wording and
capitalization.
In `@en/docs/install-and-setup/updates/update-accelerators.md`:
- Around line 10-12: Rewrite the two introductory sentences for grammar and
clarity: replace "the wso2 base products like APIM and MI in order to cater the
healthcare domain problems." with a concise sentence such as "These updates
apply to WSO2 base products, including APIM and MI, to support healthcare domain
requirements." and replace "In order to get updates for Healthcare solution we
need to get the update for two separate products as below," with something like
"To obtain Healthcare solution updates, install the updates for the two separate
products listed below:" — update the exact phrases shown ("the wso2 base
products like APIM and MI..." and "In order to get updates for Healthcare
solution...") accordingly to match tone and grammar across the document.
In `@en/docs/secure-health-apis/guides/configure-smart-on-fhir.md`:
- Line 100: The phrase "Patient Id" in the sentence starting "By decoding the
id_token you will be able to retrieve the Patient Id that we assigned to user
'johndoe'." uses inconsistent capitalization; change "Patient Id" to "Patient
ID" to match the rest of the guide and standard acronym casing, updating that
exact sentence text accordingly.
In `@TYPO_AND_GRAMMAR_REPORT.md`:
- Line 121: Item 10's summary text incorrectly states "four headings" while
listing five heading labels; update the item so the count and list match by
either changing the count to "five headings" or removing one of the listed
labels (`#Connecting`, `##Overview`, `##Set up`, `##Install`, `##Connect`) to
leave four entries—ensure the item text and the bullet/list are consistent
(refer to item 10 and the listed heading labels).
- Around line 6-61: The report's top metadata ("Total issues fixed:"), the Index
Table header counts, and the detailed numbered entries are inconsistent (showing
42, 48, and 45); update them to a single consistent total and matching
one-to-one numbering. Inspect the "Total issues fixed:" value, the Index Table
rows beginning with "| # | File | Issue Type | Summary |", and the detailed list
of numbered items (entries 1–48) and either remove the 3 extra index entries or
add the 3 missing detailed entries so the count matches (choose a single
canonical total and apply it across the "Total issues fixed:" line, the index
table numbering, and the detailed issue list). Ensure numbering, counts, and
summaries are aligned and consistent throughout the document.
---
Outside diff comments:
In `@en/docs/fhir/guides/populating-fhir-resources.md`:
- Around line 28-32: The code snippet import has a typo: change the package
import in the fenced Ballerina snippet from
"ballerinax/health.fhir.r4.internationa401" to the correct
"ballerinax/health.fhir.r4.international401" so it matches the intended FHIR IG
package name referenced in the text; update the import line in the snippet
accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b8626e80-b1cc-47f1-bcd8-8c4856766cbb
📒 Files selected for processing (22)
TYPO_AND_GRAMMAR_REPORT.mden/docs/advance-topics/guides/enable-workflow.mden/docs/configurations/email-notification.mden/docs/data-transformation/guides/hl7v2-fhir.mden/docs/fhir/guides/connecting-ehr-emr-systems.mden/docs/fhir/guides/expose-fhir-apis.mden/docs/fhir/guides/exposing-an-api.mden/docs/fhir/guides/fhir-repository-connector.mden/docs/fhir/guides/metadata-api.mden/docs/fhir/guides/parsing-and-serializing.mden/docs/fhir/guides/populating-fhir-resources.mden/docs/fhir/guides/profiles-and-extensions.mden/docs/fhir/guides/smart-api.mden/docs/get-started/architecture.mden/docs/get-started/introduction.mden/docs/hl7/guides/overview.mden/docs/hl7/guides/populating-hl7-message.mden/docs/install-and-setup/manual.mden/docs/install-and-setup/updates/overview.mden/docs/install-and-setup/updates/update-accelerators.mden/docs/secure-health-apis/guides/configure-smart-on-fhir.mden/docs/secure-health-apis/guides/smart-on-fhir-overview.md
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/fhir/guides/expose-fhir-apis.md`:
- Line 62: Replace the awkward phrase "in a similar manner as in instance-level
interactions" in the sentence starting "Type level - Type-level interactions..."
with a clearer construction such as "similarly to instance-level interactions"
so the full line reads "Type level - Type-level interactions are handled
similarly to instance-level interactions." Ensure only the phrasing changes and
preserve the existing meaning and punctuation around "Type level - Type-level
interactions."
In `@en/docs/get-started/introduction.md`:
- Line 9: Replace the unhyphenated compound modifier "auto generative" with the
hyphenated form "auto-generative" in the introduction paragraph (the sentence
referencing "auto generative, easily extensible and well supported set of
healthcare accelerators") so the compound modifier before "set of healthcare
accelerators" is grammatically correct and consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 58b45b9d-9c14-47d5-a35e-7fe9451d3d6f
📒 Files selected for processing (9)
en/docs/data-transformation/guides/hl7v2-fhir.mden/docs/fhir/guides/connecting-ehr-emr-systems.mden/docs/fhir/guides/expose-fhir-apis.mden/docs/fhir/guides/populating-fhir-resources.mden/docs/get-started/architecture.mden/docs/get-started/introduction.mden/docs/install-and-setup/updates/overview.mden/docs/install-and-setup/updates/update-accelerators.mden/docs/secure-health-apis/guides/configure-smart-on-fhir.md
✅ Files skipped from review due to trivial changes (5)
- en/docs/install-and-setup/updates/update-accelerators.md
- en/docs/install-and-setup/updates/overview.md
- en/docs/data-transformation/guides/hl7v2-fhir.md
- en/docs/fhir/guides/populating-fhir-resources.md
- en/docs/secure-health-apis/guides/configure-smart-on-fhir.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ovements Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
nirmal070125
force-pushed
the
fix/typos-and-grammar
branch
from
May 21, 2026 11:35
ae7fbc1 to
e7c5989
Compare
sameeragunarathne
approved these changes
May 21, 2026
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.
Summary
en/docs/Types of fixes
Receipients→Recipients,Accelarator→Accelerator,Ballrina→Ballerina,crendetials→credentials)Files changed
get-started/introduction.mdget-started/architecture.mdconfigurations/email-notification.mddata-transformation/guides/hl7v2-fhir.mdfhir/guides/connecting-ehr-emr-systems.mdfhir/guides/expose-fhir-apis.mdfhir/guides/exposing-an-api.mdfhir/guides/fhir-repository-connector.mdfhir/guides/metadata-api.mdfhir/guides/parsing-and-serializing.mdfhir/guides/populating-fhir-resources.mdfhir/guides/profiles-and-extensions.mdfhir/guides/smart-api.mdhl7/guides/overview.mdhl7/guides/populating-hl7-message.mdinstall-and-setup/manual.mdinstall-and-setup/updates/overview.mdinstall-and-setup/updates/update-accelerators.mdsecure-health-apis/guides/configure-smart-on-fhir.mdsecure-health-apis/guides/smart-on-fhir-overview.mdadvance-topics/guides/enable-workflow.md🤖 Generated with Claude Code