Skip to content

Conversation

@Gopinaathan
Copy link

@Gopinaathan Gopinaathan commented Nov 14, 2025

Corrected formatting, link structure, and Jinja template syntax to improve readability and ensure proper rendering in the documentation site.

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.

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 [email protected] 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 [email protected] 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

Release Notes

  • Documentation
    • Updated and refined documentation links for improved navigation consistency
    • Streamlined documentation structure for better maintainability

Corrected formatting, link structure, and Jinja template syntax to improve readability and ensure proper rendering in the documentation site.
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 14, 2025

Walkthrough

The pull request restructures the tiles data in the documentation index by adding an explicit array layer per column, removes HTML/CSS rendering markup and styling, adjusts link URLs with trailing slashes, and relocates AI-related links from integration-guides to developer-guides.

Changes

Cohort / File(s) Summary
Documentation Index Restructure
en/docs/index.md
Reworked tiles data structure with explicit array-per-column nesting; removed HTML/CSS rendering block; standardized link URLs with trailing slashes; moved AI-related links to developer-guides

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Verify the tiles array structure maintains proper data integrity and column grouping
  • Confirm all adjusted URLs (especially relocated AI-related links) are correct and resolve properly
  • Ensure removal of HTML/CSS code doesn't break dependent rendering logic elsewhere

Possibly related PRs

  • Update event integration doc #157: Updates index tiles and relocates AI-related links to developer-guides, directly aligning with the link URL adjustments and path refinements in this PR

Suggested reviewers

  • rosensilva
  • KavinduZoysa
  • anupama-pathirage
  • NipunaRanasinghe

Poem

🐰 The tiles now dance in columns bright,
Wrapped in arrays, organized right!
Old HTML fades, links take their flight,
To developer-guides seeking the light—
Data flows clean, the index shines white! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description consists entirely of the template structure with placeholder sections and guidance text. Almost all required sections (Purpose, Goals, Approach, User stories, Release note, Documentation, Training, Certification, Marketing, Automation tests, Security checks, Samples, Related PRs, Migrations, Test environment, Learning) lack substantive content—only a brief introductory sentence is provided before the empty template sections. Fill in the required sections with specific information: link related issues under Purpose, explain the formatting/link fixes under Goals and Approach, provide concrete details for Documentation/Training/Certification/Security checks if applicable, and specify the test environment used for verification.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—fixing documentation issues in the BI homepage (index.md), which aligns with the file modified and the restructuring of tiles data and link corrections described in the summary.
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
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
en/docs/index.md (1)

1-94: Consider documentation and changelog for the removal of HTML/CSS rendering markup.

The AI summary indicates that HTML/CSS rendering markup and styling were removed from this file. While this change aligns with moving to a data-driven structure, ensure:

  1. Alternative rendering logic exists elsewhere (e.g., a template layout file)
  2. The change is documented in the PR description or a related issue
  3. Team members are aware of where rendering/styling now occurs
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79dbd79 and 9aae236.

📒 Files selected for processing (1)
  • en/docs/index.md (1 hunks)
🔇 Additional comments (3)
en/docs/index.md (3)

36-37: Duplicate link detected: "AI Agents and other Gen AI Integrations" appears in both "AI" and "Integration Guides" tiles.

The link to "integration-guides/ai/agents/" is defined twice (line 36 in the "AI" tile and line 44 in the "Integration Guides" tile) with identical title and URL. Clarify whether this is intentional for redundancy/accessibility or if one should be removed or updated.

Also applies to: 44-44


1-94: Verify the data structure is consumed correctly by the rendering engine.

The tiles structure has been refactored to explicitly nest tiles within column arrays. Ensure the documentation site's rendering template (which previously used the removed HTML/CSS) correctly consumes this nested array-per-column format.


7-13: All URLs verified and valid.

All 40+ relative documentation paths exist in the repository structure with consistent trailing slash formatting. External URLs are live and accessible:

No malformed paths or broken links detected. The PR's URL adjustments are correct.

@dulajdilshan
Copy link
Contributor

@Gopinaathan can you please resolve the conflicts and update the PR?

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.

3 participants