Skip to content

Conversation

@tony
Copy link
Member

@tony tony commented Jan 25, 2026

Summary

  • Replace inline pipe-separated metadata (Default: None | Type: str | Required) with semantic <dl> definition list structure
  • Enable independent CSS styling of keys, values, and tags
  • Use Furo's guilabel pattern for "Required" tag with semi-transparent amber background
  • Support both light and dark mode with proper contrast
  • Standardize all argparse elements to use var(--code-font-size) for consistent sizing

Changes

HTML structure (before):

<p class="argparse-argument-meta">Default: <span class="nv">None</span> | Type: str | Required</p>

HTML structure (after):

<dl class="argparse-argument-meta">
  <div class="argparse-meta-item">
    <dt class="argparse-meta-key">Default</dt>
    <dd class="argparse-meta-value"><span class="nv">None</span></dd>
  </div>
  <div class="argparse-meta-item">
    <dt class="argparse-meta-key">Type</dt>
    <dd class="argparse-meta-value"><span class="nv">str</span></dd>
  </div>
  <dt class="argparse-meta-tag">Required</dt>
</dl>

Font size standardization:

  • CLI inline roles (.cli-option, .cli-metavar, etc.)
  • Usage blocks (pre.argparse-usage)
  • Argument names (.argparse-argument-name)
  • Metadata elements (.argparse-meta-key, .argparse-meta-value, .argparse-meta-tag)

All now use var(--code-font-size) (Furo's 81.25%) for consistency with other code elements.

Test plan

  • All 1017 tests pass
  • Docs build successfully
  • Visual verification at /cli/edit.html in light and dark modes

Replace inline pipe-separated metadata (Default: None | Type: str | Required)
with a semantic <dl> structure that enables independent CSS styling of keys,
values, and tags. Uses Furo's guilabel pattern for Required tag with
semi-transparent amber background for light/dark mode compatibility.
@codecov
Copy link

codecov bot commented Jan 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 80.11%. Comparing base (3487e8b) to head (eacd727).
⚠️ Report is 9 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1011   +/-   ##
=======================================
  Coverage   80.11%   80.11%           
=======================================
  Files          28       28           
  Lines        2409     2409           
  Branches      457      457           
=======================================
  Hits         1930     1930           
  Misses        356      356           
  Partials      123      123           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Standardize font-size across CLI inline roles, usage blocks, argument
names, and metadata to use Furo's --code-font-size variable (81.25%)
for consistent sizing with other code elements.
@tony tony force-pushed the more-cli-docs-2 branch 2 times, most recently from b93d34f to 45232b5 Compare January 25, 2026 17:11
tony added 2 commits January 25, 2026 11:12
Lowercase metavars like `socket_name` were split at underscores because
the regex `[a-z][-a-z0-9]*` didn't include `_`. Changed to `[a-z][-a-z0-9_]*`
in all 6 pattern locations.

Fixes: tmuxp load usage showing `<span>socket</span>_name` instead of
`<span>socket_name</span>`.
tony added 3 commits January 25, 2026 12:17
Furo's "auto" theme follows system prefers-color-scheme. The meta tag
dark styling only targeted explicit data-theme="dark", missing the
auto-dark case where body:not([data-theme="light"]) applies.
The light mode override for headerlink colors used body:not([data-theme="dark"])
which incorrectly matches auto mode even when system is dark. Split into
explicit light selector plus media query for auto + system light.
@tony tony merged commit eb91815 into master Jan 25, 2026
14 checks passed
@tony tony deleted the more-cli-docs-2 branch January 25, 2026 19:28
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.

2 participants