Improve clarity and consistency in the Quick Start Guide

[madubashinii]

This PR improves the clarity and consistency of the Quick Start Guide by refining introductory text and enhancing readability.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Warning

Rate limit exceeded

@madubashinii has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 40 minutes and 6 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 40 minutes and 6 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ad9bb45d-70c0-47a8-a074-3c7b2e3d37f8

📥 Commits

Reviewing files that changed from the base of the PR and between cfd3f3d and 3db5111.

📒 Files selected for processing (1)

• en/docs/get-started/api-manager-quick-start-guide.md

Walkthrough

Updated documentation wording in the API Manager quick start guide, including adding "locally" to VM description, changing "set the" to "set up the" for JAVA_HOME environment variable, and adjusting Step 1 to reference "WSO2 API-M Publisher Portal" explicitly.

Changes

Cohort / File(s)	Summary
Documentation Wording Updates en/docs/get-started/api-manager-quick-start-guide.md	Minor wording refinements: added "locally" to VM context, changed "set the" to "set up the" for JAVA_HOME setup, and updated Step 1 to use full portal name "WSO2 API-M Publisher Portal" instead of "the Publisher Portal of WSO2 API-M."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is vague and lacks required template sections like Purpose, Goals, Approach, Release notes, Documentation impact, and Testing details.	Expand the description to include Purpose (with issue links if applicable), Goals, Approach, Release notes, Documentation section, and Test environment details following the repository template.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change—improving clarity and consistency in the Quick Start Guide documentation.
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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

en/docs/get-started/api-manager-quick-start-guide.md (1)

15-18: Minor terminology inconsistency.

Line 15 uses "set up the JAVA_HOME environment variable" while Line 18 uses "setting the JAVA_HOME environment variable." For consistency, consider aligning the terminology.

📝 Suggested fix for consistency

     !!! tip
-        For more information on setting the `JAVA_HOME` environment variable for different operating systems, see [Setup and Install]({{base_path}}/install-and-setup/install/installing-the-product/installing-api-m-runtime/#setting-up-java_home)
+        For more information on setting up the `JAVA_HOME` environment variable for different operating systems, see [Setup and Install]({{base_path}}/install-and-setup/install/installing-the-product/installing-api-m-runtime/#setting-up-java_home)

🤖 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` around lines 15 - 18,
Update the wording so both occurrences use the same phrasing and formatting for
the environment variable; replace "set up the JAVA_HOME environment variable"
with "set the `JAVA_HOME` environment variable" (or vice versa) and ensure the
variable is consistently formatted as `JAVA_HOME` throughout the document,
including the referenced Setup and Install note.

🤖 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 9: Update the introductory sentence "Choose a deployment option to start
the WSO2 API Manager All-in-one package locally. The All-in-one package contains
all core components in a single JVM for simplified deployment." to remove or
rephrase "locally" so it accurately covers both local and remote deployments;
specifically edit that sentence in
en/docs/get-started/api-manager-quick-start-guide.md (the line starting "Choose
a deployment option...") to either drop "locally" or replace it with wording
such as "locally or on a remote cluster" or "on your chosen environment" to
reflect Kubernetes and cloud-hosted scenarios.

---

Nitpick comments:
In `@en/docs/get-started/api-manager-quick-start-guide.md`:
- Around line 15-18: Update the wording so both occurrences use the same
phrasing and formatting for the environment variable; replace "set up the
JAVA_HOME environment variable" with "set the `JAVA_HOME` environment variable"
(or vice versa) and ensure the variable is consistently formatted as `JAVA_HOME`
throughout the document, including the referenced Setup and Install note.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ee02c979-8860-4cf5-a199-f829c396f514

📥 Commits

Reviewing files that changed from the base of the PR and between bf3dc41 and cfd3f3d.

📒 Files selected for processing (1)

• en/docs/get-started/api-manager-quick-start-guide.md