Fix typos, formatting and clarity issues in Quick Start Guide#10945
Fix typos, formatting and clarity issues in Quick Start Guide#10945SadevSaranga wants to merge 2 commits intowso2:masterfrom
Conversation
Improved the Quick Start Guide by fixing minor grammar, formatting, and clarity issues. Added the missing word “the” before “WSO2 API Manager,” corrected the bullet list under the download step, and changed “zip” to uppercase “ZIP.” Explained <API-M_HOME> for beginners, added quotes around UI buttons like “Sign In” and “Try It Out,” and fixed minor punctuation and repeated phrases. Clarified instructions in Step 3 so users can easily reach the API Console. These changes make the guide easier to read and follow for new users.
SadevSaranga
requested review from
chamilaadhi and
tharikaGitHub
as code owners
|
|
WalkthroughDocumentation refinements to the API Manager quick-start guide, including terminology normalization (standardizing "WSO2 API-M" to "WSO2 API Manager"), formatting adjustments, button label updates, URL placeholder substitutions, and step clarifications without altering procedures or control flow. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can use your project's `stylelint` configuration to improve the quality of CSS code reviews.Add a Stylelint configuration file to your project to customize how CodeRabbit runs |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/docs/get-started/api-manager-quick-start-guide.md`:
- Line 79: In the sentence containing "URL.Copy" inside
en/docs/get-started/api-manager-quick-start-guide.md (the string "URL.Copy" is
the identifier), insert a space so it reads "URL. Copy" to separate the two
sentences; update that exact occurrence in the document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 48f21aaf-f847-426e-bff0-6146291ea071
📒 Files selected for processing (1)
en/docs/get-started/api-manager-quick-start-guide.md
| | `HTTP Response Body` | `{"hello": "world"}` | | ||
|
|
||
| Finally click **Generate My HTTP Response** to save and generate the mock service url. | ||
| Finally, click **Generate My HTTP Response** to save and generate the mock service URL.Copy this URL as you will need it in step 5. |
There was a problem hiding this comment.
Missing space between sentences.
There's a missing space between "URL." and "Copy" in the sentence. It currently reads "URL.Copy" but should be "URL. Copy".
📝 Proposed fix
- Finally, click **Generate My HTTP Response** to save and generate the mock service URL.Copy this URL as you will need it in step 5.
+ Finally, click **Generate My HTTP Response** to save and generate the mock service URL. Copy this URL as you will need it in step 5.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Finally, click **Generate My HTTP Response** to save and generate the mock service URL.Copy this URL as you will need it in step 5. | |
| Finally, click **Generate My HTTP Response** to save and generate the mock service URL. Copy this URL as you will need it in step 5. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/docs/get-started/api-manager-quick-start-guide.md` at line 79, In the
sentence containing "URL.Copy" inside
en/docs/get-started/api-manager-quick-start-guide.md (the string "URL.Copy" is
the identifier), insert a space so it reads "URL. Copy" to separate the two
sentences; update that exact occurrence in the document.
2 participants
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit