Skip to content

Conversation

@wso2-engineering-bot
Copy link

@wso2-engineering-bot wso2-engineering-bot commented Dec 2, 2025

This PR was automatically generated by Claude AI.

  • Issue: [Docs] Add a warning in the custom layout editor document section product-is#26132
  • Type: Documentation (Suggestions)
  • Summary: Added a warning message in the custom layout editor documentation to inform users that they should copy and paste the default HTML content in the HTML tab before making CSS modifications when only overriding styling of existing components. This ensures the structure remains intact while allowing users to customize the appearance.
  • Affected Versions: 7.2.0, next
  • Style Scope Verification: Microsoft Style Guidelines have been applied ONLY to the newly added warning message content without modifying existing content style.
  • Verification: mkdocs build passed for both affected versions (7.2.0 and next)

Summary by CodeRabbit

  • Documentation
    • Added guidance for branding customization: when applying CSS styling overrides, copy the default HTML content into the HTML tab before modifying CSS to preserve the structure.

✏️ Tip: You can customize this high-level summary in your review settings.

…affected versions (product-is#26132)

Added a warning message in the custom layout editor documentation to inform users that they should copy and paste the default HTML content in the HTML tab before making CSS modifications when only overriding styling. This ensures the structure remains intact while allowing users to customize the appearance.

Affected versions:
- 7.2.0
- next
@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025

Walkthrough

A warning admonition was added to the branding customization guide after step 5, instructing users to copy default HTML content into the HTML tab before modifying CSS to preserve structure. This is a documentation-only update with no code logic changes.

Changes

Cohort / File(s) Change Summary
Documentation
en/includes/guides/branding/customize-layouts-with-editor.md
Added warning admonition clarifying CSS override best practices and HTML structure preservation

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • pavinduLakshan

Poem

🐰 A guide now brighter, clearer still,
With warnings placed with gentle skill,
"Preserve thy HTML!" we say with care,
Lest CSS styles make structure bare! 📋✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is largely incomplete, missing required template sections like Purpose, Related PRs, Test environment, and Security checks. Complete the PR description by filling out all required template sections, including Purpose with issue links, Related PRs, Test environment details, and Security checks verification.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a CSS-only customization warning to the layout editor documentation.
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
  • Commit unit tests in branch fixing-product-is-issue-26132-1764656599

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbc99ae and df9b4d7.

📒 Files selected for processing (1)
  • en/includes/guides/branding/customize-layouts-with-editor.md (1 hunks)
🔇 Additional comments (1)
en/includes/guides/branding/customize-layouts-with-editor.md (1)

44-45: Solid documentation improvement that addresses a real user pain point.

The warning is well-placed after step 5 and provides clear, actionable guidance. The message is concise, explains the rationale, and aligns with existing admonition patterns in the document. The advice—to copy default HTML before modifying CSS—is sound practice that preserves component structure while enabling styling customization.


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.

@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.


wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

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