Skip to content

Fix API Platform version 1.2.0 and 1.0.0 quickstart guides - #428

Open
selectiveduplicate wants to merge 4 commits into
wso2:mainfrom
selectiveduplicate:sakib-qsg-fixes
Open

Fix API Platform version 1.2.0 and 1.0.0 quickstart guides #428
selectiveduplicate wants to merge 4 commits into
wso2:mainfrom
selectiveduplicate:sakib-qsg-fixes

Conversation

@selectiveduplicate

Copy link
Copy Markdown
Contributor

Purpose

Please note the title.

Closes #426.

Checklist

  • Verified that llms.txt (located at en/docs/llms.txt) is updated for AI readiness content.
  • Ensured meaningful alt text for images and that the information contained in an image also appears in text so the relevant info exists in the body of the document.
  • Added or updated frontmatter for the respective pages.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

@coderabbitai

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@selectiveduplicate, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 22d2245c-f818-42f1-9e18-cfc151efbc9d

📥 Commits

Reviewing files that changed from the base of the PR and between 3076601 and 1f8cbd5.

📒 Files selected for processing (1)
  • en/docs/api-gateway/1.2.0/quick-start-guide.md
📝 Walkthrough

Walkthrough

The API Gateway 1.0.0 and 1.2.0 quick-start guides now contain corrected version commands and clearer step-by-step instructions for setup, invocation, port checks, and shutdown.

Changes

API Gateway quick-start documentation

Layer / File(s) Summary
Distribution command corrections
en/docs/api-gateway/1.0.0/quick-start-guide.md
The guide uses the 1.0.0 distribution commands. The port-check instructions are formatted within the port-conflict tip.
Step-by-step gateway setup
en/docs/api-gateway/1.2.0/quick-start-guide.md
The guide separates download, extraction, navigation, setup, credential export, startup, and health verification into titled steps.
Invocation and shutdown instructions
en/docs/api-gateway/1.2.0/quick-start-guide.md
The guide separates HTTP and HTTPS examples, reformats the PowerShell port check, and labels shutdown options that preserve or remove the controller-data volume.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: arshardh, anugayan

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description includes the purpose and linked issue, but most required sections contain only template placeholders. Complete the Goals, Approach, User stories, Release note, Documentation, testing, security, and other applicable sections.
Out of Scope Changes check ⚠️ Warning The 1.0.0 version correction is not covered by linked issue #426, which targets only the 1.2.0 quickstart presentation. Link a separate issue for the 1.0.0 correction or remove that change from this pull request.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the fixes to the API Platform 1.2.0 and 1.0.0 quickstart guides.
Linked Issues check ✅ Passed The 1.2.0 guide changes address issue #426 by separating the quickstart commands into sequential steps.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ 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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/docs/api-gateway/1.2.0/quick-start-guide.md`:
- Line 62: Update the Markdown formatting in the quick-start guide: add blank
lines around the affected headings and fenced code blocks, label the credentials
fence as bash, use plain body labels instead of bold text at the referenced
sections, and change the headings to sentence case: “Run the setup script” and
“Export admin credentials.”
- Around line 96-102: Update the health-check introduction in the quick-start
guide to say “Verify that the Gateway Controller is healthy:” and identify the
Gateway Controller as the component checked by the endpoint. State that the
controller is ready to accept API configurations, using “Gateway Controller”
consistently and avoiding wording that implies the data-plane runtime is ready.
- Around line 92-93: Update the quick-start Docker Compose command to run the
gateway stack in detached mode by adding the -d option, matching the
corresponding 1.0.0 and 1.1.0 guides so the health-check steps can continue in
the same terminal.
🪄 Autofix

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6fb7dd3a-57f5-441a-804b-4a4fc21c6132

📥 Commits

Reviewing files that changed from the base of the PR and between b3cf6f7 and 93466c7.

📒 Files selected for processing (2)
  • en/docs/api-gateway/1.0.0/quick-start-guide.md
  • en/docs/api-gateway/1.2.0/quick-start-guide.md

Comment thread en/docs/api-gateway/1.2.0/quick-start-guide.md Outdated
Comment thread en/docs/api-gateway/1.2.0/quick-start-guide.md Outdated
Comment thread en/docs/api-gateway/1.2.0/quick-start-guide.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/docs/api-gateway/1.0.0/quick-start-guide.md`:
- Line 11: Update the last_updated frontmatter field in quick-start-guide.md to
the actual content update date, using 2026-08-10 if the PR update occurred on
August 10, 2026.
🪄 Autofix

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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f938b6c7-690e-49ea-a475-96ccafdcf897

📥 Commits

Reviewing files that changed from the base of the PR and between 93466c7 and 3076601.

📒 Files selected for processing (1)
  • en/docs/api-gateway/1.0.0/quick-start-guide.md

Comment thread en/docs/api-gateway/1.0.0/quick-start-guide.md
@ShalkiWenushika

Copy link
Copy Markdown
Contributor

The 1.1.0 QSG should also be updated in the same format.

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.

[Bug]: Quick Start section presentation is broken

2 participants