Skip to content

Commit 7f50983

Browse files
nirmal070125claude
nirmal070125
and
claude
committed
Fix typos and grammar errors across documentation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 1e373cb commit 7f50983

22 files changed

Lines changed: 382 additions & 57 deletions

‎TYPO_AND_GRAMMAR_REPORT.md‎

Lines changed: 325 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,325 @@
1+
# Documentation — Typos & Grammar Error Report
2+
3+
**Date:** 2026-05-21
4+
**Branch:** fix/typos-and-grammar
5+
**Scope:** All `.md` files under `en/docs/` (excluding `en/docs/old-content/`)
6+
**Total issues fixed:** 42
7+
8+
---
9+
10+
## Index Table
11+
12+
| # | File | Issue Type | Summary |
13+
|---|------|------------|---------|
14+
| 1 | `get-started/introduction.md` | Grammar | "that been" → "that has been" |
15+
| 2 | `get-started/introduction.md` | Grammar | "self register" → "self-register" |
16+
| 3 | `get-started/introduction.md` | Grammar | Removed orphaned sentence fragment "approve workflows." |
17+
| 4 | `get-started/architecture.md` | Punctuation | Missing space after `#` in heading |
18+
| 5 | `get-started/architecture.md` | Grammar | "depicts of what" → "depicts what" |
19+
| 6 | `get-started/architecture.md` | Typo | Broken Markdown link: `FHIR resource]` → `[FHIR resource]` |
20+
| 7 | `configurations/email-notification.md` | Typo | "Receipients" → "Recipients" (×2 headings) |
21+
| 8 | `data-transformation/guides/hl7v2-fhir.md` | Typo | "Genarate" → "Generate" |
22+
| 9 | `data-transformation/guides/hl7v2-fhir.md` | Typo | "They types.bal" → "The types.bal" |
23+
| 10 | `fhir/guides/connecting-ehr-emr-systems.md` | Punctuation | Missing space after `##` in four headings |
24+
| 11 | `fhir/guides/connecting-ehr-emr-systems.md` | Grammar | "specificationbased" → "specification-based" |
25+
| 12 | `fhir/guides/connecting-ehr-emr-systems.md` | Grammar | "FHIR based" → "FHIR-based" |
26+
| 13 | `fhir/guides/connecting-ehr-emr-systems.md` | Grammar | "the user of the init" → "the use of the init" |
27+
| 14 | `fhir/guides/expose-fhir-apis.md` | Grammar | "might different from" → "might differ from" |
28+
| 15 | `fhir/guides/expose-fhir-apis.md` | Grammar | "to a another" → "to another" |
29+
| 16 | `fhir/guides/expose-fhir-apis.md` | Typo | "pre templeted" → "pre-templated" |
30+
| 17 | `fhir/guides/expose-fhir-apis.md` | Grammar | "refer the" → "refer to the" |
31+
| 18 | `fhir/guides/exposing-an-api.md` | Grammar | "Build a custom integration flows" → "Build custom integration flows" |
32+
| 19 | `fhir/guides/fhir-repository-connector.md` | Grammar | "create a new for a specified type" → "create a new resource for a specified type" |
33+
| 20 | `fhir/guides/fhir-repository-connector.md` | Typo | "Requesed" → "Requested" (×2 occurrences) |
34+
| 21 | `fhir/guides/fhir-repository-connector.md` | Typo | "operationOutcomee" → "operationOutcome" |
35+
| 22 | `fhir/guides/fhir-repository-connector.md` | Grammar | "For we only support" → "Currently only ... is supported" |
36+
| 23 | `fhir/guides/fhir-repository-connector.md` | Grammar | "in the future releases" → "in future releases" |
37+
| 24 | `fhir/guides/metadata-api.md` | Grammar | "The that operations are supported" → "The operations that are supported" |
38+
| 25 | `fhir/guides/metadata-api.md` | Grammar | "is consisting above configurations as below" → "containing the above configurations is shown below" |
39+
| 26 | `fhir/guides/metadata-api.md` | Grammar | "needs to be configured" → "need to be configured"; "Choreo configurable editor" → "the Choreo configurable editor" |
40+
| 27 | `fhir/guides/parsing-and-serializing.md` | Typo | "internationa401" → "international401"; extra space before period removed |
41+
| 28 | `fhir/guides/populating-fhir-resources.md` | Grammar | "Create ballerina project" → "Create a Ballerina project" |
42+
| 29 | `fhir/guides/populating-fhir-resources.md` | Typo | "internationa401" → "international401"; extra space before period removed |
43+
| 30 | `fhir/guides/profiles-and-extensions.md` | Typo | "Ballrina Central" → "Ballerina Central" |
44+
| 31 | `fhir/guides/smart-api.md` | Grammar | "needs to be configured" → "need to be configured"; "Choreo configurable editor" → "the Choreo configurable editor" |
45+
| 32 | `hl7/guides/overview.md` | Typo | "Messagess" → "Messages" (double s) |
46+
| 33 | `hl7/guides/populating-hl7-message.md` | Grammar | "Create ballerina project" → "Create a Ballerina project" |
47+
| 34 | `install-and-setup/manual.md` | Typo | "Accelarator" → "Accelerator" |
48+
| 35 | `install-and-setup/updates/overview.md` | Grammar | "there different types" → "there are different types"; "subscriptions tiers" → "subscription tiers" |
49+
| 36 | `install-and-setup/updates/overview.md` | Grammar | Reworded awkward "but if this has been fixed" sentence |
50+
| 37 | `install-and-setup/updates/overview.md` | Grammar | "recommend to applying" → "recommends applying" |
51+
| 38 | `install-and-setup/updates/update-accelerators.md` | Grammar | "Inorder" / "inorder" → "In order" (×2) |
52+
| 39 | `install-and-setup/updates/update-accelerators.md` | Grammar | "desire update level" → "desired update level" (×2) |
53+
| 40 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "Intall" → "Install" |
54+
| 41 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "crendetials" → "credentials" |
55+
| 42 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "Carbon Colsole" → "Carbon Console" |
56+
| 43 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "selct" → "select" |
57+
| 44 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "retrive" → "retrieve" (×2) |
58+
| 45 | `secure-health-apis/guides/configure-smart-on-fhir.md` | Typo | "Authntication" → "Authentication" |
59+
| 46 | `secure-health-apis/guides/smart-on-fhir-overview.md` | Typo | "endpointss" → "endpoints" |
60+
| 47 | `advance-topics/guides/enable-workflow.md` | Grammar | "in a application" → "in an application" |
61+
| 48 | `advance-topics/guides/enable-workflow.md` | Typo | "displyed" → "displayed" |
62+
63+
---
64+
65+
## Detailed Fixes by File
66+
67+
### `en/docs/get-started/introduction.md`
68+
69+
1. **Grammar** — "that been an open-source integration platform" missing verb
70+
- Before: `that been an open-source integration platform`
71+
- After: `that has been an open-source integration platform`
72+
73+
2. **Grammar** — Hyphenation of compound modifier
74+
- Before: `can self register, and gain access`
75+
- After: `can self-register, and gain access`
76+
77+
3. **Grammar** — Orphaned sentence fragment
78+
- Before: `all through one portal. approve workflows. Further`
79+
- After: `all through one portal. Further`
80+
81+
---
82+
83+
### `en/docs/get-started/architecture.md`
84+
85+
4. **Punctuation** — Missing space after `#` in H1 heading
86+
- Before: `#Architecture and key components`
87+
- After: `# Architecture and key components`
88+
89+
5. **Grammar** — Redundant preposition
90+
- Before: `The diagram below depicts of what the WSO2 Open Healthcare offers.`
91+
- After: `The diagram below depicts what the WSO2 Open Healthcare offers.`
92+
93+
6. **Typo** — Broken Markdown link (missing opening bracket)
94+
- Before: `FHIR defines a RESTful API interface to any FHIR resource](https://hl7.org/fhir/http.html).`
95+
- After: `FHIR defines a RESTful API interface to any [FHIR resource](https://hl7.org/fhir/http.html).`
96+
97+
---
98+
99+
### `en/docs/configurations/email-notification.md`
100+
101+
7. **Typo** — Misspelled "Receipients" in two section headings
102+
- Before: `To Specified Roles and Receipients` (×2)
103+
- After: `To Specified Roles and Recipients`
104+
105+
---
106+
107+
### `en/docs/data-transformation/guides/hl7v2-fhir.md`
108+
109+
8. **Typo** — "Genarate" misspelling
110+
- Before: `1. Genarate the files using openapi files as below.`
111+
- After: `1. Generate the files using openapi files as below.`
112+
113+
9. **Typo** — "They" should be "The"
114+
- Before: `2. They types.bal file is auto generated`
115+
- After: `2. The types.bal file is auto generated`
116+
117+
---
118+
119+
### `en/docs/fhir/guides/connecting-ehr-emr-systems.md`
120+
121+
10. **Punctuation** — Missing space after `##` in four headings (`#Connecting`, `##Overview`, `##Set up`, `##Install`, `##Connect`)
122+
123+
11. **Grammar** — Missing hyphen in compound adjective
124+
- Before: `any FHIR based or Open API specificationbased EHR/EMR system`
125+
- After: `any FHIR-based or Open API specification-based EHR/EMR system`
126+
127+
12. **Grammar** — Wrong word "user" should be "use"
128+
- Before: `describes the user of the init and the searchPatient`
129+
- After: `describes the use of the init and the searchPatient`
130+
131+
---
132+
133+
### `en/docs/fhir/guides/expose-fhir-apis.md`
134+
135+
13. **Grammar** — "might different" is not grammatical
136+
- Before: `versioning strategy might different from one system to a another`
137+
- After: `versioning strategy might differ from one system to another`
138+
139+
14. **Typo** — "templeted" misspelling
140+
- Before: `are pre templeted in the API definitions`
141+
- After: `are pre-templated in the API definitions`
142+
143+
15. **Grammar** — Missing preposition
144+
- Before: `refer the [official FHIR documentation]`
145+
- After: `refer to the [official FHIR documentation]`
146+
147+
---
148+
149+
### `en/docs/fhir/guides/exposing-an-api.md`
150+
151+
16. **Grammar** — Article error with plural noun
152+
- Before: `Build a custom integration flows`
153+
- After: `Build custom integration flows`
154+
155+
---
156+
157+
### `en/docs/fhir/guides/fhir-repository-connector.md`
158+
159+
17. **Grammar** — Missing noun
160+
- Before: `create a new for a specified type`
161+
- After: `create a new resource for a specified type`
162+
163+
18. **Typo** — "Requesed" misspelling (×2)
164+
- Before: `Requesed histories`
165+
- After: `Requested histories`
166+
167+
19. **Typo** — "operationOutcomee" double letter
168+
- Before: `operationOutcomee`
169+
- After: `operationOutcome`
170+
171+
20. **Grammar** — "For we only support" is not grammatical
172+
- Before: `For we only support [FHIRPath Patch]...the remaining content types will be supported in the future releases.`
173+
- After: `Currently only [FHIRPath Patch] is supported; the remaining content types will be supported in future releases.`
174+
175+
---
176+
177+
### `en/docs/fhir/guides/metadata-api.md`
178+
179+
21. **Grammar** — "The that operations" — extra word
180+
- Before: `The that operations are supported`
181+
- After: `The operations that are supported`
182+
183+
22. **Grammar** — "is consisting above configurations as below"
184+
- Before: `A sample Config.toml is consisting above configurations as below.`
185+
- After: `A sample Config.toml containing the above configurations is shown below.`
186+
187+
23. **Grammar** — Subject-verb disagreement
188+
- Before: `configurables...needs to be configured in Choreo configurable editor`
189+
- After: `configurables...need to be configured in the Choreo configurable editor`
190+
191+
---
192+
193+
### `en/docs/fhir/guides/parsing-and-serializing.md`
194+
195+
24. **Typo** — Package name typo in prose (not code block)
196+
- Before: `ballerinax/health.fhir.r4.internationa401` (missing `l`)
197+
- After: `ballerinax/health.fhir.r4.international401`
198+
199+
---
200+
201+
### `en/docs/fhir/guides/populating-fhir-resources.md`
202+
203+
25. **Grammar** — Missing article
204+
- Before: `Create ballerina project using the following command. It will create the ballerina project`
205+
- After: `Create a Ballerina project using the following command. It will create the Ballerina project`
206+
207+
26. **Typo** — Same package name typo in prose
208+
- Before: `ballerinax/health.fhir.r4.internationa401`
209+
- After: `ballerinax/health.fhir.r4.international401`
210+
211+
---
212+
213+
### `en/docs/fhir/guides/profiles-and-extensions.md`
214+
215+
27. **Typo** — "Ballrina" misspelling
216+
- Before: `pushed to Ballrina Central`
217+
- After: `pushed to Ballerina Central`
218+
219+
---
220+
221+
### `en/docs/fhir/guides/smart-api.md`
222+
223+
28. **Grammar** — Same as metadata-api.md
224+
- Before: `configurables...needs to be configured in Choreo configurable editor`
225+
- After: `configurables...need to be configured in the Choreo configurable editor`
226+
227+
---
228+
229+
### `en/docs/hl7/guides/overview.md`
230+
231+
29. **Typo** — Double "s"
232+
- Before: `Customizing HL7 Messagess`
233+
- After: `Customizing HL7 Messages`
234+
235+
---
236+
237+
### `en/docs/hl7/guides/populating-hl7-message.md`
238+
239+
30. **Grammar** — Missing article; improper capitalization
240+
- Before: `Create ballerina project using...It will create the ballerina project`
241+
- After: `Create a Ballerina project using...It will create the Ballerina project`
242+
243+
---
244+
245+
### `en/docs/install-and-setup/manual.md`
246+
247+
31. **Typo** — "Accelarator" misspelling
248+
- Before: `Compatible Healthcare Accelarator`
249+
- After: `Compatible Healthcare Accelerator`
250+
251+
---
252+
253+
### `en/docs/install-and-setup/updates/overview.md`
254+
255+
32. **Grammar** — Missing verb "are"
256+
- Before: `and there different types of subscriptions tiers available`
257+
- After: `and there are different types of subscription tiers available`
258+
259+
33. **Grammar** — Reworded awkward conditional sentence
260+
- Before: `but if this has been fixed in an update already,and if you have missed a recent update, it could be possible that this issues is already fixed in a most recent update.`
261+
- After: `if this has been fixed in an update already and you have missed a recent update, it is possible that the issue is already fixed in a more recent update.`
262+
263+
34. **Grammar** — Subject-verb agreement
264+
- Before: `WSO2 always recommend to applying security updates sooner`
265+
- After: `WSO2 always recommends applying security updates sooner`
266+
267+
---
268+
269+
### `en/docs/install-and-setup/updates/update-accelerators.md`
270+
271+
35. **Grammar** — "Inorder" / "inorder" is not a word (×2)
272+
- Before: `Inorder to get updates` / `inorder to cater`
273+
- After: `In order to get updates` / `in order to cater`
274+
275+
36. **Grammar** — Wrong adjective form (×2)
276+
- Before: `the latest/ desire update level` (×2)
277+
- After: `the latest/ desired update level`
278+
279+
---
280+
281+
### `en/docs/secure-health-apis/guides/configure-smart-on-fhir.md`
282+
283+
37. **Typo** — "Intall" misspelling
284+
- Before: `Intall the latest WSO2 API Manager`
285+
- After: `Install the latest WSO2 API Manager`
286+
287+
38. **Typo** — "crendetials" misspelling
288+
- Before: `crendetials of the above user`
289+
- After: `credentials of the above user`
290+
291+
39. **Typo** — "Carbon Colsole" misspelling
292+
- Before: `log into Carbon Colsole`
293+
- After: `log into Carbon Console`
294+
295+
40. **Typo** — "selct" misspelling
296+
- Before: `and selct 'Patient ID'`
297+
- After: `and select 'Patient ID'`
298+
299+
41. **Typo** — "retrive" misspelling (×2)
300+
- Before: `retrive the Patient ID` / `retrive the Patient Id`
301+
- After: `retrieve the Patient ID` / `retrieve the Patient Id`
302+
303+
42. **Typo** — "Authntication" misspelling
304+
- Before: `redirected to the Authntication Portal`
305+
- After: `redirected to the Authentication Portal`
306+
307+
---
308+
309+
### `en/docs/secure-health-apis/guides/smart-on-fhir-overview.md`
310+
311+
43. **Typo** — "endpointss" double s
312+
- Before: `(authorization and token endpointss)`
313+
- After: `(authorization and token endpoints)`
314+
315+
---
316+
317+
### `en/docs/advance-topics/guides/enable-workflow.md`
318+
319+
44. **Grammar** — Wrong article before vowel sound
320+
- Before: `in a application creation request`
321+
- After: `in an application creation request`
322+
323+
45. **Typo** — "displyed" misspelling
324+
- Before: `The application creation request is displyed`
325+
- After: `The application creation request is displayed`

‎en/docs/advance-topics/guides/enable-workflow.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Healthcare accelerator provides the following capabilities.
1111

1212
- View the user details in a user creation request.
1313
- Option to approve/reject user creation request.
14-
- View the application details in a application creation request.
14+
- View the application details in an application creation request.
1515
- Option to approve/reject application creation request.
1616

1717
## How to enable the User/Application creation workflow
@@ -51,6 +51,6 @@ merge.sh
5151
1. Sign in to the Devportal and create an application.
5252
2. Since the application creation flow is enabled, initially application will remain as inactive until it gets approved.
5353
3. Login to the Admin Portal (https://localhost:9443/admin) and click on '**Application Creation**'.
54-
4. The application creation request is displyed in the Admin Portal for Admin user to approve/reject.
54+
4. The application creation request is displayed in the Admin Portal for Admin user to approve/reject.
5555
![application creation request](/assets/img/learn/workflow/application-creation-approval.png)
5656
5. Once the application creation request is approved, user should be able to use the application as it becomes active.

‎en/docs/configurations/email-notification.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This is a required configuration.
4343
<strong>Note:</strong>The values given within '${}' are the default placeholders that will be populated internally.
4444

4545
:::
46-
### Upon User Approval/Rejection - To Specified Roles and Receipients
46+
### Upon User Approval/Rejection - To Specified Roles and Recipients
4747

4848
```json
4949
[[healthcare.notification.mail]]
@@ -77,7 +77,7 @@ This is a required configuration.
7777
email_body = "<html><body>A new application has been created. Visit the <a href=\"${server_url}/admin/tasks/application-creation/\">admin portal</a> to approve/reject.</body></html>"
7878
```
7979

80-
### Upon Application Approval/Rejection - To Specified Roles and Receipients
80+
### Upon Application Approval/Rejection - To Specified Roles and Recipients
8181

8282
```json
8383
[[healthcare.notification.mail]]

‎en/docs/data-transformation/guides/hl7v2-fhir.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,11 +220,11 @@ The service processes incoming POST requests containing HL7v2 messages. When a m
220220

221221
Let's look into the the detailed implementation of this. Let's assume the [custom-service-openapi.yaml](../references/custom-service-openapi.yaml) is inside the resources folder.
222222

223-
1. Genarate the files using openapi files as below.
223+
1. Generate the files using openapi files as below.
224224
```bash
225225
bal openapi -i resources/custom-service-openapi.yaml --mode service -o <OUTPUT-FOLDER>
226226
```
227-
2. They types.bal file is auto generated to the specified folder and it does not need any changes to be done.
227+
2. The types.bal file is auto generated to the specified folder and it does not need any changes to be done.
228228
3. Update the custom-service-openapi-service.bal file as below.
229229
```ballerina
230230
// AUTO-GENERATED FILE.

0 commit comments

Comments
 (0)