docs: fix grammar and formatting issues in Key Concepts#10713
docs: fix grammar and formatting issues in Key Concepts#10713AayeshaF wants to merge 1 commit intowso2:master-backupfrom
Conversation
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.
|
No actionable comments were generated in the recent review. 🎉 WalkthroughMinor 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
This commit fixes minor grammar and formatting issues in the Key Concepts section:
Corrected subject-verb agreement in API Resource section:
Fixed formatting in API Visibility section (removed "."):
Replaced dash with colon in Rate Limits section:
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
Samples
N/A
Related PRs
N/A
Migrations (if applicable)
N/A
Test environment
N/A
Learning
N/A
Summary by CodeRabbit