Move v3 markdown components onto boostlook - #2535
Conversation
📝 WalkthroughWalkthroughThe v3 templates add ChangesBoostlook rich-text styling
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related issues
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
Adds the boostlook class to the v3 components that render markdown or rich text (content modal, markdown card, shared user-profile bio, post detail body, release highlights descriptions) and removes their temporary component-level markdown CSS, which now lives in boostlook's 17-site-components.css. The vendored boostlook-v3.css that carries those rules is added by the boostlook v3 integration PR (boostorg#2411); this change depends on it.
a33d637 to
ed2a7ac
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 `@templates/v3/includes/_release_highlights_card.html`:
- Line 43: Update the release-highlight description markup around the
inline_markdown call so it does not receive Boostlook’s painted background:
either move the boostlook class to a non-painted wrapper or add a scoped
transparent-background override in Boostlook’s release-highlight styling.
Preserve the existing description rendering and card theme appearance.
🪄 Autofix (Beta)
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: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: c16edda4-28f3-4e22-a350-a0637b622033
📒 Files selected for processing (9)
static/css/v3/content-modal.cssstatic/css/v3/markdown-card.cssstatic/css/v3/post-detail.cssstatic/css/v3/release-highlights-card.csstemplates/news/v3/detail.htmltemplates/v3/includes/_content_modal.htmltemplates/v3/includes/_markdown_card.htmltemplates/v3/includes/_release_highlights_card.htmltemplates/v3/includes/_user_profile_bio_card.html
julhoang
left a comment
There was a problem hiding this comment.
Hi @julioest ! Thanks for your help with tackling this task.
Currently there are still a couple of issue with integrating Boostlook that I noticed:
- The post detail body section has a white background.
- From the sample post (that I created from the WYSIWIG post page), I also happened to notice that the
highlightjsclass are not added to<pre>elements – can we add that so that the code syntax will get coloured?
- On the Download page, the documentation card is missing an overflow scroll and some horizontal padding.
|
Hey @julhoang! That ugly rendering is expected on this PR by itself. The styles live in Pull these files in from #2411's branch: Then just hard-refresh. No rebuild or migrate needed. Check again |
javiercoronadonarvaez
left a comment
There was a problem hiding this comment.
LGTM! Great work. Thanks for those instructions at the end.
julhoang
left a comment
There was a problem hiding this comment.
This is looking great, thanks again for adding the testing instructions @julioest!
I can pre-approve this now, but I also have 2 questions:
- I noticed that the inline code in the What's New section is blue (set by
styles.css), while the inline code inside the Release Note card is grey (set byboostlook). I'm wondering if we should stop setting the code color instyles.cssaltogether, or whether it's safer to set it specifically inrelease-highlights-card.cssto narrow the scope of impact? 🤔
- I understand this one comes from the
boostlookrules, but the line gap between the title and description in thesect1div currently feels a bit too narrow. There's amargin-bottom: 0.5rem;rule on theh2that ends up being overridden bymargin: 0. I realize exceptions toboostlookmay be hard to grant, so maybe we can just log a note about this case inboostlookfor now, and revisit it later?
|
Comrade @julhoang, thank ya and great questions.
Yep, I think those styles should live in boostlook.
I'm taking a quick look |
|
Kept the The heading gap isn't a boostlook exception: that |
Picks up boostlook 24744f4: the inline-code reset now also matches the leaf case where the boostlook class sits on the code's direct parent, and Asciidoctor .sectN headings get their gap back inside markdown cards. Build output only.
Issue: #2491
Summary & Context
Moves the v3 components that render markdown / rich text off their temporary component-level CSS and onto Boostlook. Each rich-text container gets the
boostlookclass, and its markdown styling moves into Boostlook's17-site-components.css, scoped under.boostlook.<class>; the component CSS is reduced to a pointer comment. This is a pure move: the rendered markdown is unchanged, the styling just lives in one place now.This is the component-side half of the Boostlook v3 sweep. It depends on the Boostlook v3 vendor PR (#2411), which adds the vendored
static/css/v3/boostlook-v3.cssand thebase.htmlwiring that loads it. Develop does not yet contain that file, so on its own these components would be unstyled - this should land after, or together with, #2411.Changes
boostlookclass to each rich-text container:_content_modal.html,_markdown_card.html,_release_highlights_card.html,_user_profile_bio_card.html, and the news post body (news/v3/detail.html).content-modal.css,markdown-card.css,post-detail.css, andrelease-highlights-card.css. Those rules now live in Boostlook's17-site-components.cssunder.boostlook.<class>, and each component file is reduced to a pointer comment.Components covered: content modal, markdown card (shared with the user-profile bio), post detail (news body), and release highlights.
Please list any potential risks or areas that need extra attention during review/testing
boostlook-v3.css, so merging this alone would leave these components unstyled. Land it after or together with Story: Add support for boostlook v3 and vendor the file #2411.boostlookclass.|safe-HTML cards are not markdown and are outside a markdown sweep.Screenshots
No visual change intended - this is a styling move, so before and after render identically. Verified locally with before/after compare pages for each component.
Peer-review testing steps
boostlook-v3.cssbeing loaded.v3Waffle flag./releases/latest//users/me/.boostlook.<class>rules are applying).Self-review Checklist
Frontend