docs(ui): enhance mdbook docs aesthetics with custom css - #268
docs(ui): enhance mdbook docs aesthetics with custom css#268Xploit-Ghost wants to merge 3 commits into
Conversation
Signed-off-by: Anvesh <127006149+Xploit-Ghost@users.noreply.github.com>
Signed-off-by: Anvesh <127006149+Xploit-Ghost@users.noreply.github.com>
PR Check Summary
CI will run: build, test, clippy, fmt, cargo-deny, DCO, semver. |
|
Warning Review limit reached
More reviews will be available in 51 minutes and 25 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR enhances project documentation through two complementary improvements: Rustdoc examples in the Layout API that demonstrate shape and stride behavior, and a custom CSS stylesheet for the mdBook site that introduces modern typography, readability constraints, styled code blocks, and a sticky navigation bar with glassmorphism for mobile screens. ChangesDocumentation Improvements
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
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 `@docs/theme/custom.css`:
- Around line 2-4: The CSS root variable --fonts references 'Inter' but the font
is never loaded; update the stylesheet to load Inter by adding a font import or
`@font-face` before the :root declaration (e.g., import Inter from Google Fonts or
your CDN/self-hosted URL) so the font-family declared in :root (--fonts)
actually uses Inter at runtime; ensure the import URL matches the desired
weights/display settings and that the `@import/`@font-face appears above the :root
selector so browsers apply it.
🪄 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: 7bce6011-7583-438e-ad2c-56b4d5bb42b4
📒 Files selected for processing (3)
crates/mohu-buffer/src/layout.rsdocs/book.tomldocs/theme/custom.css
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This PR introduces a custom UI enhancement for the project's user-facing
mdBookdocumentation.Changes made:
docs/theme/custom.csscontaining rules for modern typography (Interfallback stack), tighter letter spacing, readability width limits, and a frosted-glass sticky menu for mobile views.docs/book.tomlto correctly loadadditional-css = ["theme/custom.css"].These changes significantly improve the aesthetic quality and reading experience of the
mohudocs while maintaining full compatibility with the existing build pipeline.Resolves #267
Thank you for your time!
Please add the appropriate gssoc:approved , difficulty, type and quality labels.
Summary by CodeRabbit
Release Notes