Skip to content

Move Quick Start Guide before Setup in API Gateway 1.1.0 nav - #396

Open
Skynettheone wants to merge 1 commit into
wso2:mainfrom
Skynettheone:fix/gateway-1.1.0-nav-order
Open

Move Quick Start Guide before Setup in API Gateway 1.1.0 nav#396
Skynettheone wants to merge 1 commit into
wso2:mainfrom
Skynettheone:fix/gateway-1.1.0-nav-order

Conversation

@Skynettheone

Copy link
Copy Markdown

Summary

Fixes #330.

In en/mkdocs.yml, the API Gateway 1.1.0 version's nav section listed Setup before Quick Start Guide:

- Overview: api-gateway/1.1.0/overview.md
- Setup:
    ...
- Quick Start Guide: api-gateway/1.1.0/quick-start-guide.md

The Setup page covers architectural details (storage & backends, artifact templating, upstream timeouts), which per the issue should come after the Quick Start rather than before it. The next version's nav section already has the correct order (Overview -> Quick Start Guide -> Setup -> Policies -> ...).

Change

Reordered the 1.1.0 nav section to match the next version's structure: Overview, Quick Start Guide, Setup, then the rest unchanged.

Test plan

  • Confirmed the full mkdocs.yml still parses as valid YAML after the change.
  • Confirmed the 1.1.0 nav section now reads Overview, Quick Start Guide, Setup, Policies, ... matching the next version's ordering.

@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 36b1185a-b974-45b5-9147-3d3dc935cad6

📥 Commits

Reviewing files that changed from the base of the PR and between d418028 and 23fcfa3.

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

📝 Walkthrough

Walkthrough

The API Gateway 1.1.0 navigation now places Quick Start Guide before Setup. The Setup entries remain unchanged.

Changes

API Gateway navigation

Layer / File(s) Summary
Reorder API Gateway guides
en/mkdocs.yml
The 1.1.0 Quick Start Guide appears before the Setup section.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: thushani-jayasekera, lasanthas, piumal1999

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change and test plan but omits most required template sections and checklist details. Complete the required template sections, or mark non-applicable sections as N/A with brief explanations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the navigation reorder in the API Gateway 1.1.0 documentation.
Linked Issues check ✅ Passed The PR moves Quick Start Guide immediately after Overview and places Setup after it, satisfying issue #330.
Out of Scope Changes check ✅ Passed The PR changes only the API Gateway 1.1.0 navigation order required by issue #330.
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

2 participants