Skip to content

Polish typography and fix sidebar toggle arrow#53

Merged
justin808 merged 5 commits intomainfrom
jg/15-typography-polish
Mar 23, 2026
Merged

Polish typography and fix sidebar toggle arrow#53
justin808 merged 5 commits intomainfrom
jg/15-typography-polish

Conversation

@justin808
Copy link
Member

@justin808 justin808 commented Mar 22, 2026

Summary

  • Add structural typography improvements: section heading borders, blockquote styling, table formatting, inline code padding, and section comment dividers in custom.css
  • Fix sidebar toggle arrow rendering as black square in dark mode by removing broken background override on .menu__caret::before and adding --ifm-menu-link-sublist-icon-filter: invert(1) for dark theme
  • Style collapsible sidebar category links with bolder weight

Closes #15

Visual Changes

Compare side-by-side:

What to look for

Area Before After
H1/H2 headings No bottom border Light gray underline beneath h1 and h2
Blockquotes Default Docusaurus styling Left border, muted text color, no background
Inline code Default styling Bordered pill with subtle background
Tables Default styling Alternating row striping, cell borders, horizontal scroll
Sidebar categories Normal weight text Bold (600) category labels with content color
Sidebar toggle arrow (dark mode) Black square Proper arrow icon (inverted for visibility)
Section dividers in CSS None Comment separators for maintainability

Test plan

  • Compare main vs preview on /docs/configuration — heading underlines visible
  • Toggle dark mode on preview — sidebar arrows render correctly (not black squares)
  • Check blockquote on /docs/configuration (the "Good News!" block)
  • Verify inline code rendering (e.g. /config/initializers/react_on_rails.rb)

🤖 Generated with Claude Code


Note

Low Risk
Low risk: CSS-only presentation tweaks and homepage copy updates with no functional or data-handling changes beyond minor visual behavior.

Overview
Updates Docusaurus theming to improve readability and consistency: adds H1/H2 underlines, refined inline-code vs code-block styling, blockquote and table formatting (borders, zebra striping, horizontal scroll), and clearer section separators in custom.css.

Adjusts sidebar visuals by bolding collapsible category links and fixing dark-mode sublist caret visibility via --ifm-menu-link-sublist-icon-filter: invert(1).

Refines index.tsx homepage messaging and CTAs across persona cards, recommended flows, migration section, consultation banner, and testimonials to be shorter and more action-oriented.

Written by Cursor Bugbot for commit c470165. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Style

    • Refined dark-mode navigation icon rendering and adjusted navbar/footer/sidebar link styles, including stronger weight for collapsible sidebar links.
    • Enhanced Markdown visuals: underlined H1/H2, tightened inline code styling, simplified preformatted code blocks, added blockquote borders/spacing, and scrollable, bordered tables with zebra striping.
  • Documentation

    • Updated site marketing copy: hero, section headings/subtitles, persona/flow/migration descriptions, CTAs, consultation banner, and testimonials.

@coderabbitai
Copy link

coderabbitai bot commented Mar 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: fff76066-8191-4fac-9a4e-22f0fa19f17c

📥 Commits

Reviewing files that changed from the base of the PR and between 7ff0104 and c470165.

📒 Files selected for processing (1)
  • prototypes/docusaurus/src/pages/index.tsx
✅ Files skipped from review due to trivial changes (1)
  • prototypes/docusaurus/src/pages/index.tsx

Walkthrough

Updated Docusaurus styling and marketing copy: added a dark-mode submenu icon inversion and stronger collapsible sidebar link styling; extended Markdown typography and table styles; adjusted hero, persona, flow, migration, consultation banner, and testimonials text on the index page. No runtime logic changes.

Changes

Cohort / File(s) Summary
Docusaurus CSS
prototypes/docusaurus/src/css/custom.css
Added dark-mode override --ifm-menu-link-sublist-icon-filter: invert(1); increased weight/color for .menu__list-item-collapsible > .menu__link; multiple Markdown typography refinements (h1/h2 bottom borders, inline code padding/border-radius, disabled pre code background/border, blockquote left border/spacing); tables made horizontally scrollable with explicit cell borders, padding, bold headers, and zebra striping.
Marketing page copy
prototypes/docusaurus/src/pages/index.tsx
Reworded hero, persona, flow, migration, consultation banner, and testimonials headings/subtitles/descriptions and primary CTA text. No structural or API changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐇 I hopped through styles and tuned each line,

Dark icons flipped and side links now define.
Headings trimmed, tables scroll with grace,
New copy hopped into its place.
A rabbit's nibble — small design embrace.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR includes homepage copy/CTA updates that are unrelated to the typography polish or sidebar arrow fix objectives in issue #15. Remove or move homepage marketing copy updates to a separate PR focused on content updates, as they are outside the scope of issue #15.
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title specifically mentions 'sidebar toggle arrow' but the primary changes are typography improvements; the arrow fix is secondary.
Linked Issues check ✅ Passed The PR addresses issue #15 by implementing typography improvements including heading underlines, blockquote styling, table formatting, and code styling consistent with GitHub-like rendering.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg/15-typography-polish

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

@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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@prototypes/docusaurus/src/css/custom.css`:
- Around line 109-112: The current rule ".menu__list-item-collapsible
.menu__link" styles all descendant links including nested submenu items; change
it to target only the direct category link by using the child combinator on the
selector (i.e., replace the descendant selector with
".menu__list-item-collapsible > .menu__link") so only the immediate collapsible
header receives font-weight:600 and color:var(--ifm-color-content).
- Around line 169-171: The zebra striping selector currently targets all rows
via ".markdown tr:nth-child(2n)" which can color header rows; change the
selector to target only table body rows (e.g., ".markdown tbody
tr:nth-child(2n)" or ".markdown table tbody tr:nth-child(2n)") so header rows
remain unaffected, update the rule in custom.css accordingly, and verify
multi-row table headers are no longer striped.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 05516c13-cd6d-4b58-bd5d-1e51f2a9673e

📥 Commits

Reviewing files that changed from the base of the PR and between 7701418 and c400fa1.

📒 Files selected for processing (1)
  • prototypes/docusaurus/src/css/custom.css

@github-actions
Copy link

github-actions bot commented Mar 22, 2026

Cloudflare preview deployed.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c400fa1634

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Collapsible link style overrides active link color
    • I restricted the collapsible link color rule to non-active links so .menu__link--active keeps its intended active text color.

Create PR

Or push these changes by commenting:

@cursor push dc86fa7b07
Preview (dc86fa7b07)
diff --git a/prototypes/docusaurus/src/css/custom.css b/prototypes/docusaurus/src/css/custom.css
--- a/prototypes/docusaurus/src/css/custom.css
+++ b/prototypes/docusaurus/src/css/custom.css
@@ -106,7 +106,7 @@
   font-weight: 600;
 }
 
-.menu__list-item-collapsible .menu__link {
+.menu__list-item-collapsible .menu__link:not(.menu__link--active) {
   font-weight: 600;
   color: var(--ifm-color-content);
 }

justin808 and others added 2 commits March 22, 2026 14:09
Closes #15

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Revert the font-size and weight reductions from the previous typography
commit while keeping the useful structural additions: heading border
separators, blockquote styling, table zebra-striping, sidebar hover
states, and code padding.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Use child combinator for collapsible sidebar links to preserve active link color
- Scope zebra striping to tbody rows only
- Exclude pre>code from inline code styles to avoid breaking fenced blocks
- Tighten all home page text: remove meta-commentary, cut filler words,
  make headings action-oriented instead of philosophical

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Dark mode table striping invisible due to matching colors
    • Added a dark-theme-specific table stripe override to use #21262d so alternating rows remain visually distinct from the dark page background.

Create PR

Or push these changes by commenting:

@cursor push 7864b32d2f
Preview (7864b32d2f)
diff --git a/prototypes/docusaurus/src/css/custom.css b/prototypes/docusaurus/src/css/custom.css
--- a/prototypes/docusaurus/src/css/custom.css
+++ b/prototypes/docusaurus/src/css/custom.css
@@ -199,6 +199,10 @@
   background: var(--site-soft-surface);
 }
 
+[data-theme='dark'] .markdown tbody tr:nth-child(2n) {
+  background: #21262d;
+}
+
 /* ── Pagination & misc ────────────────────────────────────── */
 
 .pagination-nav__link {


.markdown tbody tr:nth-child(2n) {
background: var(--site-soft-surface);
}
Copy link

Choose a reason for hiding this comment

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

Dark mode table striping invisible due to matching colors

Medium Severity

The new alternating table row striping uses var(--site-soft-surface), which in dark mode resolves to #0d1117 — the exact same value as --ifm-background-color in dark mode. This makes the striped rows indistinguishable from non-striped rows, so the visual striping effect is completely invisible in dark mode. The codebase already acknowledges this mismatch for .button--secondary:hover, which has a dedicated dark-mode override using #21262d instead of --site-soft-surface.

Additional Locations (1)
Fix in Cursor Fix in Web

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Revert hero h1, persona/flow/migration section headings, OSS comparison
description, and Pro flow summary to their original wording. These were
changed too aggressively and lost product name visibility or meaning.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@justin808 justin808 merged commit b02fe8f into main Mar 23, 2026
4 checks passed
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.

Typography polish: tighten GitHub-like font rendering and spacing

1 participant