Skip to content

docs: fix grammar and formatting issues in Key Concepts#10713

Open
AayeshaF wants to merge 1 commit intowso2:master-backupfrom
AayeshaF:patch-1
Open

docs: fix grammar and formatting issues in Key Concepts#10713
AayeshaF wants to merge 1 commit intowso2:master-backupfrom
AayeshaF:patch-1

Conversation

@AayeshaF
Copy link

@AayeshaF AayeshaF commented Feb 16, 2026

This commit fixes minor grammar and formatting issues in the Key Concepts section:

  1. Corrected subject-verb agreement in API Resource section:

    • "An API Resource has a set of HTTP methods that operates on it." → "An API Resource has a set of HTTP methods that operate on it."
  2. Fixed formatting in API Visibility section (removed "."):

    • "Restricted by role. - Visible only to the users under the creator's tenant domain..." → "Restricted by role - Visible only to the users under the creator’s tenant domain..."
  3. Replaced dash with colon in Rate Limits section:

    • "Rate limiting can be useful to -" → "Rate limiting can be useful to:"

No functional changes were made.

Purpose

Fix minor grammar and formatting issues in Key Concepts section of WSO2 API Manager documentation.

Goals

Improve clarity and readability of the documentation; no functional changes.

Approach

Directly edited the Markdown file key-concepts.md in the get-started folder of the documentation.

User stories

N/A

Release note

Documentation-only change; no release note required.

Documentation

This PR is the documentation update for the Key Concepts page.

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

N/A, documentation change only.

Security checks

  • Followed secure coding standards: N/A
  • Ran FindSecurityBugs plugin and verified report: N/A
  • Confirmed no secrets committed: yes

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

N/A

Learning

N/A

Summary by CodeRabbit

  • Documentation
    • Minor grammar corrections and punctuation improvements throughout the API documentation.
    • Enhanced formatting consistency and list presentation standards in the key concepts guide, with refinements to API resource path descriptions, HTTP methods definitions, API visibility section, and rate limits entry formatting for improved readability, clarity, and consistency across all documentation materials.

This commit fixes minor grammar and formatting issues in the Key Concepts section:

1. Corrected subject-verb agreement in API Resource section:
   - "An API Resource has a set of HTTP methods that operates on it."
     → "An API Resource has a set of HTTP methods that operate on it."

2. Fixed formatting in API Visibility section:
   - "Restricted by role. - Visible only to the users under the creator's tenant domain..."
     → "Restricted by role – visible only to users under the creator’s tenant domain..."

3. Replaced dash with colon in Rate Limits section:
   - "Rate limiting can be useful to -"
     → "Rate limiting can be useful to:"

No functional changes were made.
@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2026

No actionable comments were generated in the recent review. 🎉


Walkthrough

Minor textual and markdown formatting updates to the key concepts documentation. Grammar corrections applied ("operates on it" to "operate on it") and markdown list formatting standardized across API Visibility and Rate Limits entries for consistency.

Changes

Cohort / File(s) Summary
Documentation Updates
en/docs/get-started/key-concepts.md
Grammar correction in HTTP Methods entry; markdown formatting adjustments in API Visibility bullets and Rate Limits list introduction for consistency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

✨ A dash removed, a comma placed just right,
Grammar polished to shine so bright,
Lists now align in perfect array,
Documentation blooms in every way! 🐰

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing grammar and formatting issues in the Key Concepts documentation.
Description check ✅ Passed The description covers all essential sections of the template with appropriate content for a documentation-only fix, clearly explaining the changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

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

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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.

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.

1 participant