Skip to content

Update docs - #419

Closed
Krishanx92 wants to merge 4 commits into
wso2:mainfrom
Krishanx92:self-hosted
Closed

Update docs#419
Krishanx92 wants to merge 4 commits into
wso2:mainfrom
Krishanx92:self-hosted

Conversation

@Krishanx92

Copy link
Copy Markdown
Contributor

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

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 7, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

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

Next review available in: 54 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: 7dfb85a0-202e-4c3a-b4ec-75a25215a457

📥 Commits

Reviewing files that changed from the base of the PR and between 72d9844 and 27a09f7.

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

Walkthrough

The quick-start guides now use stable 1.2.0 gateway archives. MkDocs navigation now targets API Gateway and AI Gateway 1.2.0 documentation, plus API Portal & MCP Hub and AI Workspace 1.0.0 documentation.

Changes

Documentation release promotion

Layer / File(s) Summary
Release quick-start commands
en/docs/ai-gateway/1.2.0/..., en/docs/api-gateway/1.2.0/...
Quick-start commands now download and extract stable 1.2.0 gateway archives.
Gateway versioned navigation
en/mkdocs.yml
API Gateway and AI Gateway navigation trees and version defaults now target 1.2.0.
Platform versioned navigation
en/mkdocs.yml
API Portal & MCP Hub and AI Workspace navigation now targets version 1.0.0.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description contains only template headings and placeholders, with no purpose, goals, approach, testing details, or related issue information. Complete the template with the documentation changes, objectives, validation performed, affected links, and applicable checklist responses.
Title check ❓ Inconclusive The title is related to the documentation changes but is too generic to identify the specific release and navigation updates. Use a specific title, such as "Update 1.2.0 documentation links and MkDocs navigation".
✅ Passed checks (3 passed)
Check name Status Explanation
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.
✨ Finishing Touches 💡 1
⚔️ Resolve merge conflicts 💡
  • Resolve merge conflict in branch self-hosted
🧪 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: 2

🤖 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/ai-gateway/1.2.0/quick-start-guide.md`:
- Line 54: Rewrite the version substitution instruction as an explicit ordered
procedure in the quick-start guide. Tell readers to keep the v prefix in the
release tag used in the download URL, and replace every 1.2.0 occurrence in the
URL, archive name, and directory name with the chosen released version.

In `@en/mkdocs.yml`:
- Around line 339-410: Resolve the broken 1.0.0 navigation entries for the
api-portal and ai-workspace sections by adding all referenced Markdown files
under en/docs, or removing/updating entries whose documentation is not
available. Verify every 1.0.0 navigation target resolves before the MkDocs build
or release.
🪄 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: db56260a-2a3d-421a-a5eb-4f74d6f0a8cf

📥 Commits

Reviewing files that changed from the base of the PR and between 1cd6af1 and 72d9844.

📒 Files selected for processing (5)
  • en/docs/ai-gateway/1.2.0/llm-proxy/quick-start-guide.md
  • en/docs/ai-gateway/1.2.0/mcp-proxy/quick-start-guide.md
  • en/docs/ai-gateway/1.2.0/quick-start-guide.md
  • en/docs/api-gateway/1.2.0/quick-start-guide.md
  • en/mkdocs.yml

Comment thread en/docs/ai-gateway/1.2.0/quick-start-guide.md
Comment thread en/mkdocs.yml
@Krishanx92 Krishanx92 closed this Aug 7, 2026
@coderabbitai coderabbitai Bot mentioned this pull request Aug 7, 2026
3 tasks
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.

1 participant