Fix documentation errors: spelling and duplicate word corrections#11199
Fix documentation errors: spelling and duplicate word corrections#11199Aaisha-Amjad wants to merge 1 commit intowso2:masterfrom
Conversation
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
📝 WalkthroughDocumentation Error CorrectionsFixed 10 documentation errors across the following files: Spelling Corrections (8 files):
Duplicate Word Corrections (2 files):
All changes are documentation-only with no impact to functionality or code behavior. WalkthroughThis 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)
✏️ 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 |
There was a problem hiding this comment.
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 | 🔴 CriticalCritical: 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
📒 Files selected for processing (10)
en/CONTRIBUTE.mden/docs/api-developer-portal/invoke-apis/invoke-apis-using-tools/include-additional-headers-in-the-api-console.mden/docs/api-gateway/policies/mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.mden/docs/install-and-setup/setup/security/user-account-management.mden/docs/reference/config-catalog.mden/docs/reference/customize-product/extending-api-manager/extending-gateway/customizing-api-template-for-gateway.mden/docs/reference/faq.mden/docs/reference/governance/rule-validator/rule-validator.mden/docs/tutorials/scenarios/scenario-overview.mden/docs/tutorials/tutorials-overview.md
Summary: Fixed 10 documentation errors across 10 files, including 8 spelling mistakes and 2 duplicate word occurrences.
Spelling Errors Fixed (8 files):
Duplicate Word Errors Fixed (2 files):
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning