Skip to content

Fix documentation errors: spelling and duplicate word corrections#11199

Open
Aaisha-Amjad wants to merge 1 commit intowso2:masterfrom
Aaisha-Amjad:fix/documentation-errors
Open

Fix documentation errors: spelling and duplicate word corrections#11199
Aaisha-Amjad wants to merge 1 commit intowso2:masterfrom
Aaisha-Amjad:fix/documentation-errors

Conversation

@Aaisha-Amjad
Copy link
Copy Markdown

Summary: Fixed 10 documentation errors across 10 files, including 8 spelling mistakes and 2 duplicate word occurrences.

Spelling Errors Fixed (8 files):

  1. CONTRIBUTE.md - Fixed relavitely to relatively
  2. config-catalog.md - Fixed Comma seperated to Comma separated
  3. rule-validator.md - Fixed seperator to separator (3 instances)
  4. customizing-api-template-for-gateway.md - Fixed propert to property
  5. user-account-management.md - Fixed the a e-mail to the e-mail
  6. faq.md - Fixed deployment toml to deployment.toml
  7. scenario-overview.md - Fixed qunatis.com to quantis.com
  8. tutorials-overview.md - Fixed modifyng to modifying in URL

Duplicate Word Errors Fixed (2 files):

  1. mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md - Fixed the the to the
  2. include-additional-headers-in-the-api-console.md - Fixed the the to the

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary: Fixed 10 documentation errors across 10 files, including 8 spelling mistakes and 2 duplicate word occurrences.

Spelling Errors Fixed (8 files):
1. CONTRIBUTE.md - Fixed relavitely to relatively
2. config-catalog.md - Fixed Comma seperated to Comma separated
3. rule-validator.md - Fixed seperator to separator (3 instances)
4. customizing-api-template-for-gateway.md - Fixed propert to property
5. user-account-management.md - Fixed the a e-mail to the e-mail
6. faq.md - Fixed deployment toml to deployment.toml
7. scenario-overview.md - Fixed qunatis.com to quantis.com
8. tutorials-overview.md - Fixed modifyng to modifying in URL

Duplicate Word Errors Fixed (2 files):
1. mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md - Fixed the the to the
2. include-additional-headers-in-the-api-console.md - Fixed the the to the
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 21, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 21, 2026

📝 Walkthrough

Documentation Error Corrections

Fixed 10 documentation errors across the following files:

Spelling Corrections (8 files):

  • CONTRIBUTE.md: "relavitely" → "relatively"
  • config-catalog.md: "Comma seperated" → "Comma separated"
  • rule-validator.md: "seperator" → "separator" (3 instances: option key and nested options separator.char and separator.allowLeading)
  • customizing-api-template-for-gateway.md: "propert" → "property"
  • user-account-management.md: "a e-mail" → "the e-mail"
  • faq.md: "deployment toml" → "deployment.toml"
  • scenario-overview.md: "qunatis.com" → "quantis.com"
  • tutorials-overview.md: "modifyng" → "modifying" (in URL slug)

Duplicate Word Corrections (2 files):

  • mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md: "the the" → "the"
  • include-additional-headers-in-the-api-console.md: "the the" → "the"

All changes are documentation-only with no impact to functionality or code behavior.

Walkthrough

This pull request contains a series of documentation corrections across ten files, addressing spelling errors, grammar inconsistencies, and typos. Changes include corrections such as "relavitely" to "relatively," removal of duplicate articles ("the the" to "the"), spelling fixes for "seperated" and "seperator" to their correct forms, a URL slug correction in a tutorial link, an email address update from a misspelled domain, and a file path correction in FAQ documentation. All modifications are text-only and do not alter functionality, code structure, or configuration parameters.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the main changes: documentation corrections including spelling and duplicate word fixes across multiple files.
Description check ✅ Passed The description provides a clear summary of all 10 errors fixed with specific file names and corrections, but most template sections remain as unfilled placeholders despite being present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
en/docs/tutorials/tutorials-overview.md (1)

19-22: ⚠️ Potential issue | 🔴 Critical

Critical: HTML syntax error - incorrect closing anchor tags.

All hyperlinks in this file use <a> as the closing tag instead of </a>. This creates invalid HTML markup that will cause rendering issues.

🔧 Proposed fix for all anchor tags

Example correction for lines 19-22:

-                <li><a href="{{base_path}}/tutorials/create-and-publish-a-graphql-api">Create and Publish a GraphQL API<a></li>
-                <li><a href="{{base_path}}/tutorials/create-and-publish-awslambda-api">Create and Publish an AWS Lambda API<a></li>
-                <li><a href="{{base_path}}/tutorials/expose-a-soap-service-as-a-rest-api">Expose a SOAP Service as a REST API<a></li>
-                <li><a href="{{base_path}}/tutorials/create-and-publish-a-sequencebackend-api">Create and Publish an API with Sequence as a Backend<a></li>
+                <li><a href="{{base_path}}/tutorials/create-and-publish-a-graphql-api">Create and Publish a GraphQL API</a></li>
+                <li><a href="{{base_path}}/tutorials/create-and-publish-awslambda-api">Create and Publish an AWS Lambda API</a></li>
+                <li><a href="{{base_path}}/tutorials/expose-a-soap-service-as-a-rest-api">Expose a SOAP Service as a REST API</a></li>
+                <li><a href="{{base_path}}/tutorials/create-and-publish-a-sequencebackend-api">Create and Publish an API with Sequence as a Backend</a></li>

Apply the same pattern (changing <a> to </a>) to all remaining anchor tags on lines 27-30, 42-44, and 49-50.

Also applies to: 27-30, 42-44, 49-50

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/docs/tutorials/tutorials-overview.md` around lines 19 - 22, The anchor
tags in tutorials-overview.md are incorrectly closed with "<a>" instead of
"</a>" causing invalid HTML; update every list item link (e.g., the <a
href="{{base_path}}/tutorials/create-and-publish-a-graphql-api">, <a
href="{{base_path}}/tutorials/create-and-publish-awslambda-api">, <a
href="{{base_path}}/tutorials/expose-a-soap-service-as-a-rest-api">, <a
href="{{base_path}}/tutorials/create-and-publish-a-sequencebackend-api"> and the
other similar <a href="..."> instances referenced in the diff) to use proper
closing tags "</a>" throughout the file (also fix the other occurrences noted in
the comment).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@en/docs/tutorials/tutorials-overview.md`:
- Around line 19-22: The anchor tags in tutorials-overview.md are incorrectly
closed with "<a>" instead of "</a>" causing invalid HTML; update every list item
link (e.g., the <a
href="{{base_path}}/tutorials/create-and-publish-a-graphql-api">, <a
href="{{base_path}}/tutorials/create-and-publish-awslambda-api">, <a
href="{{base_path}}/tutorials/expose-a-soap-service-as-a-rest-api">, <a
href="{{base_path}}/tutorials/create-and-publish-a-sequencebackend-api"> and the
other similar <a href="..."> instances referenced in the diff) to use proper
closing tags "</a>" throughout the file (also fix the other occurrences noted in
the comment).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 14be9b7f-6348-4af5-87af-cc288735f8d6

📥 Commits

Reviewing files that changed from the base of the PR and between 3777d44 and 9b9549a.

📒 Files selected for processing (10)
  • en/CONTRIBUTE.md
  • en/docs/api-developer-portal/invoke-apis/invoke-apis-using-tools/include-additional-headers-in-the-api-console.md
  • en/docs/api-gateway/policies/mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md
  • en/docs/install-and-setup/setup/security/user-account-management.md
  • en/docs/reference/config-catalog.md
  • en/docs/reference/customize-product/extending-api-manager/extending-gateway/customizing-api-template-for-gateway.md
  • en/docs/reference/faq.md
  • en/docs/reference/governance/rule-validator/rule-validator.md
  • en/docs/tutorials/scenarios/scenario-overview.md
  • en/docs/tutorials/tutorials-overview.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants