-
Notifications
You must be signed in to change notification settings - Fork 0
Improvements and extra suggestions for Fluid Spacing #4
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
New section for Mobile‑first and suggestions around controlling Fluid spacing with VW to the lowest value
WalkthroughAdds a new documentation section “Mobile‑first Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches
🧪 Generate unit tests
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: 1
📜 Review details
Configuration used: Path: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/block-themes/fluid-spacing.md
(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
⚙️ CodeRabbit configuration file
**/*.md
: Review the Markdown documentation for:
- Clarity and conciseness of explanations
- Consistent formatting and heading structure
- Proper use of code blocks and inline code
- Correct spelling, grammar, and punctuation
- Accurate and up-to-date technical information
- Useful internal and external links
- Well-organized sections and logical flow
Files:
docs/block-themes/fluid-spacing.md
🪛 markdownlint-cli2 (0.18.1)
docs/block-themes/fluid-spacing.md
144-144: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Link Validation
### Reference table | ||
| **vw** | **320px** | **375px** | **Chosen when MIN = 12px** | | ||
|---|---:|---:|---| | ||
| 2vw | 6.4px | 7.5px | **MIN (12px)** | | ||
| 3vw | 9.6px | 11.25px | **MIN (12px)** | | ||
| 4vw | 12.8px | 15px | **Fluid (≥ 12.8px)** | | ||
|
||
### Final recommendation |
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.
Add required blank lines around the reference table
Markdownlint (MD058) flags this table because it isn’t separated from surrounding content by blank lines, which will fail the docs lint check. Please insert blank lines before and after the table.
### Reference table
+
| **vw** | **320px** | **375px** | **Chosen when MIN = 12px** |
|---|---:|---:|---|
| 2vw | 6.4px | 7.5px | **MIN (12px)** |
| 3vw | 9.6px | 11.25px | **MIN (12px)** |
| 4vw | 12.8px | 15px | **Fluid (≥ 12.8px)** |
+
### Final recommendation
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
### Reference table | |
| **vw** | **320px** | **375px** | **Chosen when MIN = 12px** | | |
|---|---:|---:|---| | |
| 2vw | 6.4px | 7.5px | **MIN (12px)** | | |
| 3vw | 9.6px | 11.25px | **MIN (12px)** | | |
| 4vw | 12.8px | 15px | **Fluid (≥ 12.8px)** | | |
### Final recommendation | |
### Reference table | |
| **vw** | **320px** | **375px** | **Chosen when MIN = 12px** | | |
|---|---:|---:|---| | |
| 2vw | 6.4px | 7.5px | **MIN (12px)** | | |
| 3vw | 9.6px | 11.25px | **MIN (12px)** | | |
| 4vw | 12.8px | 15px | **Fluid (≥ 12.8px)** | | |
### Final recommendation |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
144-144: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
🤖 Prompt for AI Agents
In docs/block-themes/fluid-spacing.md around lines 143 to 150, the reference
table is not separated from surrounding content by blank lines causing MD058;
insert a blank line immediately before the table (so there is an empty line
between the preceding paragraph/heading and the table) and another blank line
immediately after the table (so the following "Final recommendation" heading is
separated), then save to satisfy the markdownlint rule.
New section for Mobile-first and suggestions around controlling Fluid spacing with VW to the lowest value
Description
Adds a new documentation section: “Mobile-first
clamp()
strategy: controllingvw
for reliable spacing”.This section explains how to keep spacing at MIN on mobile (≈320–375px) by using low
vw
values (2–3vw). It includes principles, calculations, a reference table, and atheme.json
example.Related Issue: Fixes #[issue-number]
Type of Change
Quality Gate Checklist
Required for all PRs:
Content & Compliance:
Documentation Standards:
Build & Integration:
npm run build
) if catalogue changes madecoding-standards/
Testing Instructions
How to test these changes:
fluid-spacing.md
and verify a new section titled “Mobile-first clamp() strategy: controlling vw for reliable spacing” appears before “Option 1: spacingScale”.theme.json
example into a test theme’sspacingSizes
and validate spacing behaviour at mobile widths:Example verification:
npm run build
and verify no unexpected diffsScreenshots (if applicable)
N/A (documentation-only change)
Changelog Entry
Category: Added
Entry: Add Mobile-first clamp() guidance with 2–3vw recommendations, including reference table and
theme.json
example, to Fluid Spacing guide.Additional Context
fluid-spacing.md
Review Guidelines
For Reviewers:
For Authors:
By submitting this pull request, I confirm that my contribution abides by the repository governance and will be licensed under the GPL-3.0-only licence.
Summary by CodeRabbit