Skip to content

🎨 Stop boxing every inline code word in docs prose - #548

Merged
taras merged 1 commit into
mainfrom
fix/docs-inline-code-boxes
Aug 23, 2026
Merged

taras merged 1 commit into
mainfrom
fix/docs-inline-code-boxes

Conversation

@taras

@taras taras commented Aug 22, 2026

Copy link
Copy Markdown
Owner

Why

Documentation prose boxes and pads every inline code term. Sentences containing several identifiers or flags read as a chain of controls instead of continuous prose.

What changes

Before:

Inline code inside documentation prose has a border and horizontal padding.

After:

Inline code is distinguished by its monospace face, heavier weight, and full-contrast text without a surrounding box.

How it works

The existing .doc :not(pre) > code rule drops its border and padding and adds the same weight used by the shared Term component. The selector continues to exclude code inside pre, so fenced blocks remain unchanged.

How to verify it

  • Open a documentation page containing several inline identifiers or command flags and confirm the sentence reads continuously without code boxes.
  • Check both color schemes and confirm inline code remains visually distinct and legible.
  • Confirm fenced code blocks, command cards, code panels, and sidebar styling are unchanged.
  • git diff --check origin/main...origin/fix/docs-inline-code-boxes passes, catching whitespace errors in the patch.
  • A three-way merge check against current main applies the stylesheet change without conflicts.

Scope

Included

  • Restyle inline code within documentation prose.

Intentionally unchanged

  • Documentation markup, content, fenced code, command cards, code panels, navigation, and non-documentation pages remain unchanged.

Risks and limitations

  • This is a presentation-only change; rollback is the single stylesheet commit.

Scope confirmation

  • Every changed file supports the purpose described above.
  • Unrelated cleanup and formatting changes are excluded.
  • No generated or mechanical changes are present.
  • The description matches the final diff and verification performed.

@github-actions

Copy link
Copy Markdown

PR #548: 🎨 Stop boxing every inline code word in docs prose

1 files, +4 / -2

Scope

✅ PR scope looks good.

Structural

✅ No structural bloat detected.

Slop

✅ Slop indicators look low.

Static Analysis

✅ Oxlint found no issues.

Correctness

✅ Small PR — correctness review skipped.

@taras
taras enabled auto-merge (squash) August 22, 2026 18:34
`.doc :not(pre) > code` ruled and padded every inline `<code>` in
documentation body text. `main class="doc"` wraps every /docs page, so
this hit every `meta`, `exec`, `--journal`, and similar term in running
prose — a sentence with two or three of them reads as a chain of boxes
rather than a sentence.

Drop the border and padding. Keep the mono face, bump to weight 700,
and keep --ink for contrast — the same treatment `Term` in
components/Prose.tsx already uses for inline mono terms on the landing
page, so docs prose now matches how the rest of the site treats an
inline code word: distinguished by weight and font, not a box.

Fenced code blocks are untouched (`:not(pre)` already excluded them),
as are `.command`, `.code-panel`, and the docs sidebar.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0125zbFPKdEhKdUJxuRufpfj
@taras
taras force-pushed the fix/docs-inline-code-boxes branch from c33bdde to 839eb32 Compare August 22, 2026 23:52
@taras
taras merged commit fabdd0a into main Aug 23, 2026
17 checks passed
@taras
taras deleted the fix/docs-inline-code-boxes branch August 23, 2026 00:16
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