Skip to content

Reorder API Gateway setup and quickstart docs in sidebar#354

Open
kavishannip wants to merge 1 commit into
wso2:mainfrom
kavishannip:fix/reorder-setup-and-quickstart-docs
Open

Reorder API Gateway setup and quickstart docs in sidebar#354
kavishannip wants to merge 1 commit into
wso2:mainfrom
kavishannip:fix/reorder-setup-and-quickstart-docs

Conversation

@kavishannip

Copy link
Copy Markdown

Purpose

In the API Gateway sidebar navigation menu, the Quick Start guide was located after the Setup section, causing users to encounter complex architectural details before getting a hands-on introduction. This PR reorders the sidebar menu so that the Quick Start guide comes immediately after the Overview, and the Setup section is relocated towards the bottom of the API Gateway section.
Resolves #330

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

  • Place the Quick Start Guide immediately after Overview in the API Gateway sidebar navigation to enable fast, seamless developer onboarding.
  • Move the Setup section (which details storage, backends, artifact templating, and timeouts) towards the bottom of the API Gateway navigation hierarchy (before Performance) across all version branches (next, 1.1.0, and 1.0.0).

Approach

  • Reordered the nav: tree entries in en/mkdocs.yml under API Gateway for versions next, 1.1.0, and 1.0.0.
  • Positioned Quick Start Guide right below Overview.
  • Relocated Setup to appear after Management API and right before Performance.

UI Preview / Screenshots

Before:
Screenshot 2026-07-22 030249
After:
Screenshot 2026-07-22 030714

User stories

As a developer reading the API Gateway documentation, I want to find the Quick Start guide immediately after the Overview page so that I can set up and try out the Gateway quickly without being blocked by complex infrastructure configuration details.

Release note

Reordered the API Gateway sidebar navigation to place the Quick Start Guide immediately after the Overview page and move detailed Setup documentation towards the bottom of the section.

Documentation

N/A - This PR directly updates the documentation navigation layout in en/mkdocs.yml.

Training

N/A

Certification

N/A - No impact on certification exams.

Marketing

N/A

Automation tests

  • Unit tests

    N/A

  • Integration tests

    Verified static site build by running python -m mkdocs build in en/ with 0 navigation warnings or errors.

Security checks

Samples

N/A

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

  • OS: Windows 11
  • Python: 3.12
  • MkDocs: 1.4.2 (mkdocs-material 9.1.2)

Learning

Analyzed MkDocs Material navigation configuration (en/mkdocs.yml) for multi-version section structures.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cbd9e605-dcd6-4879-b541-15fef3d3f6eb

📥 Commits

Reviewing files that changed from the base of the PR and between 2355eac and a2148a9.

📒 Files selected for processing (1)
  • en/mkdocs.yml

📝 Walkthrough

Summary

  • Reordered API Gateway navigation for next, 1.1.0, and 1.0.0.
  • Moved Quick Start Guide directly after Overview.
  • Moved detailed Setup and Performance content later in the navigation to improve onboarding flow.
  • Verified the MkDocs build completed without navigation warnings or errors.

Walkthrough

The API Gateway navigation is reordered for the next, 1.1.0, and 1.0.0 documentation sections. Setup content is moved later in each section so the Overview is followed by the Quick Start Guide. Resiliency remains grouped with the relocated next setup content, and Performance pages are added to the next and 1.1.0 sections. The 1.0.0 section adds setup entries after Schemas.

Suggested reviewers: shanakama, thushani-jayasekera, anugayan

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR’s main change: reordering API Gateway docs in the sidebar.
Description check ✅ Passed The description follows the template well and includes the required sections with substantive details.
Linked Issues check ✅ Passed The change satisfies issue #330 by moving Quick Start after Overview and placing Setup lower in the API Gateway nav.
Out of Scope Changes check ✅ Passed The diff appears limited to the documented sidebar reordering in en/mkdocs.yml with no unrelated changes.
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.

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.

API Gateway Docs - Setup instructions appear before the Quick Start

1 participant