docs: CSS for environment variables table#9732
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughAdded a new CSS ruleset to style Markdown tables in documentation, defining layout, borders, spacing, header/body cell styling, code formatting within cells, and horizontal overflow behavior. Inserted after existing DocSearch icon styles in docs/css/custom.css. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks (2 passed, 1 warning)❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
This comment has been minimized.
This comment has been minimized.
|
@mendonk I cleaned up the markdown table styling a bit, reducing the font size overall and removing some of the duplicated borders. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
d3a3212 to
fe5ac1f
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docs/css/custom.css (4)
485-496: Use horizontal scrolling only; current overflow triggers vertical scrollbars and inconsistent hiding.Prefer
overflow-x: auto; overflow-y: hidden;and add cross‑browser scrollbar hiding only if necessary..markdown table { width: 100%; - border-collapse: collapse; + border-collapse: collapse; border-radius: var(--ifm-global-radius); border: var(--ifm-table-border-width) solid var(--ifm-table-border-color); - font-size: .8rem; + font-size: .875rem; /* improves readability/AA */ margin: 1.5rem 0; - overflow: scroll; - scrollbar-width: none; + overflow-x: auto; + overflow-y: hidden; + scrollbar-width: none; /* Firefox */ }If you still want hidden scrollbars, add:
/* Optional: WebKit scrollbar hiding */ .markdown table::-webkit-scrollbar { display: none; }Please verify keyboard/trackpad horizontal scroll works on macOS Safari and Windows/Firefox.
487-491: Border radius won’t render with border-collapse: collapse.Rounded corners on collapsed tables are ignored in many browsers. Either switch to
separateor round corner cells.-.markdown table { - border-collapse: collapse; +.markdown table { + border-collapse: separate; + border-spacing: 0; /* preserve tight grid */Alternatively (no collapse changes), round corners on the outer cells:
.markdown table thead th:first-child { border-top-left-radius: var(--ifm-global-radius); } .markdown table thead th:last-child { border-top-right-radius: var(--ifm-global-radius); } .markdown table tbody tr:last-child td:first-child { border-bottom-left-radius: var(--ifm-global-radius); } .markdown table tbody tr:last-child td:last-child { border-bottom-right-radius: var(--ifm-global-radius); }
533-538: Improve long-token handling inside code cells.Env var names/values can overflow. Allow soft wrapping in code blocks within tables.
.markdown table code { background-color: var(--ifm-color-emphasis-100); border-radius: 4px; padding: 0.2rem 0.4rem; font-family: var(--ifm-font-family-monospace); + white-space: normal; + overflow-wrap: anywhere; + word-break: break-word; }
480-483: Invalid CSS property on DocSearch icon.
size: 16pxis not a valid CSS property; usewidth/height(orfont-sizedepending on the icon)..DocSearch-Search-Icon { color: var(--ifm-color-emphasis-500) !important; - size: 16px !important; + width: 16px !important; + height: 16px !important; }
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/css/custom.css(1 hunks)
⏰ 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: build-and-deploy
| .markdown table thead th:last-child { | ||
| border: none; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix header last-cell border reset (use border-right only).
border: none wipes out the bottom border too; you likely intended to remove only the right divider.
-.markdown table thead th:last-child {
- border: none;
-}
+.markdown table thead th:last-child {
+ border-right: none;
+}📝 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.
| .markdown table thead th:last-child { | |
| border: none; | |
| } | |
| .markdown table thead th:last-child { | |
| border-right: none; | |
| } |
🤖 Prompt for AI Agents
In docs/css/custom.css around lines 512 to 514, the rule .markdown table thead
th:last-child currently uses border: none which removes all borders (including
the bottom border); change it to only reset the right divider by replacing
border: none with border-right: none (or border-right: 0) so the bottom border
remains intact.
|
Build successful! ✅ |
* link-to-supported-global-vars * global-vars-page-and-partial * env-var-page-split-up-big-table * split-out-tables * docs: CSS for environment variables table (#9732) * initial-sizing * Clean up table styling and remove duplicated rules * fix: Reduce table font size, remove scrollbar --------- Co-authored-by: Jonathan Kurten <kurtenj@gmail.com> * table-layout-fixed-with * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * fix: Standardize table column sizing * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * code-review * increase-table-text-size-to-1-rem * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * docs-review-and-remove-api-keys-behavior * cleanup * more-info-on-shared-playground * logging-env-vars * logging-env-vars * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * global-vars-move-table * env-and-global-vars-and-other * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * combine-table-with-intro-explanation * reduce-codefont-padding-in-tables * remove-duplicate-entry * alphabetize * remove-items-from-env-example * remove-stray-link --------- Co-authored-by: Jonathan Kurten <kurtenj@gmail.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
* link-to-supported-global-vars * global-vars-page-and-partial * env-var-page-split-up-big-table * split-out-tables * docs: CSS for environment variables table (#9732) * initial-sizing * Clean up table styling and remove duplicated rules * fix: Reduce table font size, remove scrollbar --------- Co-authored-by: Jonathan Kurten <kurtenj@gmail.com> * table-layout-fixed-with * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * fix: Standardize table column sizing * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * code-review * increase-table-text-size-to-1-rem * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * docs-review-and-remove-api-keys-behavior * cleanup * more-info-on-shared-playground * logging-env-vars * logging-env-vars * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * global-vars-move-table * env-and-global-vars-and-other * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> * combine-table-with-intro-explanation * reduce-codefont-padding-in-tables * remove-duplicate-entry * alphabetize * remove-items-from-env-example * remove-stray-link --------- Co-authored-by: Jonathan Kurten <kurtenj@gmail.com> Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>



Draft build for previewing CSS table control.
Summary by CodeRabbit