Skip to content

docs(theme): Render inline code the same in every position on the page - #1152

Merged
yurishkuro merged 2 commits into
jaegertracing:mainfrom
ysh-bot:docs-uniform-inline-code
Sep 23, 2026
Merged

yurishkuro merged 2 commits into
jaegertracing:mainfrom
ysh-bot:docs-uniform-inline-code

Conversation

@ysh-bot

@ysh-bot ysh-bot commented Sep 23, 2026 •

Copy link
Copy Markdown
Collaborator

Which problem is this PR solving?

Inline code did not render consistently. Docsy's _code.scss styles only p code, li > code, and table code as a grey chip with inherited text color, and every other position (a code span inside a bold list lead-in, in a heading, in a definition list) fell through to Bootstrap's default, which is pink. Pink is not a Jaeger color, and the same word could look different two lines apart.

Description of the changes

  • One rule in assets/scss/_styles_project.scss selects .td-content :not(pre) > code and gives every inline code span in the article body the chip styling. A second rule colors it $jaeger-blue-dark (navy) in the light theme and $jaeger-beige in the dark theme. Beige is the one warm color in the palette, so in dark mode inline code cannot be mistaken for a link, which is light teal there.
  • Code inside a link is excluded from the color rules and keeps the link color in both themes.
  • Code blocks, the navbar, the sidebars, and the footer are untouched.

How was this change tested?

  • Rendered the Delivery Guarantees and Configuration pages locally in both themes with headless Chromium. Every unlinked inline code span computes to one color per theme, rgb(26, 71, 103) light and rgb(223, 201, 162) dark, and linked code computes to the same color as its link.

🤖 Generated with Claude Code

yurishkuro and others added 2 commits September 23, 2026 11:34
Docsy styles inline code only in paragraphs, list items, and table cells, and
Bootstrap colors every other position pink, so a code span inside a bold list
lead-in looked different from one in the paragraph next to it. One rule now
covers all inline code in page content: navy in the light theme, and Jaeger
beige in the dark theme so that it does not look like a link.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Yuri Shkuro <github@ysh.us>
The color rules exclude code whose parent is a link, so linked code keeps the
teal link color in both themes; the chip styling still applies to it. The
comment says the rule covers the article body rather than the whole page.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Signed-off-by: Yuri Shkuro <github@ysh.us>
@yurishkuro
yurishkuro merged commit 5c64186 into jaegertracing:main Sep 23, 2026
9 checks passed
@yurishkuro
yurishkuro deleted the docs-uniform-inline-code branch September 23, 2026 15:44
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