-
Notifications
You must be signed in to change notification settings - Fork 41
Fix documentation issues in Integrator: BI homepage (index.md) #178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Corrected formatting, link structure, and Jinja template syntax to improve readability and ensure proper rendering in the documentation site.
|
|
WalkthroughThe 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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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:
- Alternative rendering logic exists elsewhere (e.g., a template layout file)
- The change is documented in the PR description or a related issue
- Team members are aware of where rendering/styling now occurs
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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:
- GitHub issues: https://github.com/wso2/product-ballerina-integrator/issues ✓
- Discord invite: https://discord.com/invite/wso2 ✓
- Enterprise Support: https://wso2.com/subscription/ ✓
No malformed paths or broken links detected. The PR's URL adjustments are correct.
|
@Gopinaathan can you please resolve the conflicts and update the PR? |
Corrected formatting, link structure, and Jinja template syntax to improve readability and ensure proper rendering in the documentation site.
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
Release Notes