Skip to content

Fix broken links, add keywords, and improve style#387

Merged
pasindufernando1 merged 1 commit into
wso2:mainfrom
VellummyilumVinoth:fix-reference-links
May 14, 2026
Merged

Fix broken links, add keywords, and improve style#387
pasindufernando1 merged 1 commit into
wso2:mainfrom
VellummyilumVinoth:fix-reference-links

Conversation

@VellummyilumVinoth

@VellummyilumVinoth VellummyilumVinoth commented May 13, 2026

Copy link
Copy Markdown
Contributor

Description

  • Fixed broken deployment links in Project view and Integrator view — updated paths for WSO2 Cloud, VM-based deployment, and ICP to match current site structure
  • Fixed broken RAG cross-reference links in ai.md — replaced relative paths pointing to a missing overview.md with correct absolute paths to rag-ingestion and rag-query
  • Added keywords frontmatter to understand-ide.md, integration-view.md, library-view.md, and
    project-view.md for improved discoverability
  • Minor style fixes: corrected button label ("Generate" → "Generate with AI"), replaced "e.g." with "for
    example", fixed table header casing, and reformatted "What's next" lists to use em-dash style consistently

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.

Summary by CodeRabbit

  • Documentation
    • Enhanced IDE documentation structure with improved terminology and consistency
    • Clarified available type field configurations in flow diagram editor setup
    • Refreshed deployment target options and navigation links across IDE guides
    • Improved documentation formatting, labels, and keyword optimization for discoverability

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

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

You’ve run out of usage credits. Purchase more in the billing tab.

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

Review profile: CHILL

Plan: Pro

Run ID: 69bb3352-8577-4a30-ab5e-0534c22d266d

📥 Commits

Reviewing files that changed from the base of the PR and between b70d7f9 and b996943.

📒 Files selected for processing (12)
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/ai.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/concurrency.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/connections.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/control.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/error-handling.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/flow-diagram-editor.md
  • en/docs/develop/understand-ide/editors/flow-diagram-editor/statement.md
  • en/docs/develop/understand-ide/integrator-app.md
  • en/docs/develop/understand-ide/understand-ide.md
  • en/docs/develop/understand-ide/views/integration-view.md
  • en/docs/develop/understand-ide/views/library-view.md
  • en/docs/develop/understand-ide/views/project-view.md
📝 Walkthrough

Walkthrough

This PR updates IDE documentation across seven pages to standardize terminology, add SEO keywords, clarify UI features, and refresh deployment and navigation links throughout the Integrator IDE section.

Changes

IDE Documentation Refresh

Layer / File(s) Summary
IDE Overview Page Restructuring
en/docs/develop/understand-ide/understand-ide.md
Main IDE documentation page is restructured with frontmatter metadata, tighter introductory text, updated link labels for Views and Editors sections, and new "What's next" section with three follow-up links.
Views Documentation Consistency Updates
en/docs/develop/understand-ide/views/integration-view.md, en/docs/develop/understand-ide/views/library-view.md, en/docs/develop/understand-ide/views/project-view.md
Integration, Library, and Project view documentation pages updated with keywords frontmatter for SEO, deployment options tables revised with new target names and URLs, UI terminology updates (Generate with AI button), and "What's next" navigation links standardized across pages.
Integrator App Documentation Updates
en/docs/develop/understand-ide/integrator-app.md
Project explorer artifact-type table labels are title-cased ("Entry Points", "Data Mappers"), and "What's next" bullet list is reformatted with dash-separated phrasing and consistent capitalization across linked view pages.
Flow Diagram Editor Documentation Updates
en/docs/develop/understand-ide/editors/flow-diagram-editor/ai.md, en/docs/develop/understand-ide/editors/flow-diagram-editor/flow-diagram-editor.md
AI flow diagram editor reference links are updated to point to specific RAG ingestion and query guides instead of general RAG overview; Type field documentation is clarified to explicitly list Ballerina type kinds (record, enum, union, other).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

📚 Fresh docs blooming, keywords shine,
Views aligned in rhythm divine,
Links now point to paths so clear,
Editors thrive, the IDE's near! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides a clear summary of changes but is missing most required template sections (Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Tests, Security, Samples, Related PRs, Migrations, Test environment, Learning). Complete the PR description by filling in the remaining template sections, or clearly mark sections as 'N/A' if not applicable to this documentation-only change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: fixing broken links, adding keywords, and improving style in 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

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

@VellummyilumVinoth VellummyilumVinoth marked this pull request as draft May 13, 2026 04:57
@VellummyilumVinoth VellummyilumVinoth marked this pull request as ready for review May 13, 2026 09:16
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.

2 participants