← 输入框|github.com|刷新
Skip to content

docs: docs improvements - #7889

Merged
lalithsuresh merged 1 commit into
mainfrom
api-colors
Nov 7, 2026
Merged

lalithsuresh merged 1 commit into
mainfrom
api-colors

Conversation

@lalithsuresh

@lalithsuresh lalithsuresh commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor
  • Fix API docs styling:

Before:
image
image

After:
image
image

  • Add some more guides on use cases
  • Add missing llms.txt

Checklist

  • Unit tests added/updated
  • Integration tests added/updated
  • Documentation updated
  • Changelog updated

--openapi-input-background: var(--color-card);
--openapi-input-border: var(--color-ink);
--ifm-pre-color: var(--color-ink);
--ifm-menu-color-background-active: var(--color-ink);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pitfall (medium): In docusaurus-theme-openapi 0.7.x, Curl/styles.module.css uses this variable for .buttonGroup button:hover too, not just .selected. An unselected language tab (cURL/Python/Node…) keeps color: var(--ifm-menu-color) (surface-600, about 48% L) when hovered, so on an ink background the label is only about 2.6:1 contrast and hard to read. One possible fix is to also set the hover text colour:

.api-wrapper .col--5 [class*="buttonGroup"] button:hover { color: var(--ifm-menu-color-active); }

Or use a lighter hover background than the selected state.

@mythical-fred-oss

Copy link
Copy Markdown
Contributor

Review (CSS only, docs site)

Check Result
pre-commit run --files custom.css passed
Variables used (--color-sink/card/ink/stone/surface-400) all defined in :root
Dark mode N/A (disableSwitch: true, light only)
Scope Limited to .api-wrapper .col--5. The Curl/Response <pre> and the form inputs in theme-openapi 0.7.7 read --openapi-card-background-color and --ifm-pre-color, so they now show dark text on a warm grey background, as intended
Gates Visual-only change with before/after screenshots, so no tests needed. A one-line commit message is fine for a change this small

One medium inline note about hover contrast on the language tabs. Otherwise LGTM.

Signed-off-by: Lalith Suresh <lalith@feldera.com>
@lalithsuresh lalithsuresh changed the title docs: fix API section colors docs: docs improvements Nov 7, 2026
@lalithsuresh
lalithsuresh added this pull request to the merge queue Nov 7, 2026
Merged via the queue into main with commit 5e5d192 Nov 7, 2026
1 check passed
@lalithsuresh
lalithsuresh deleted the api-colors branch November 7, 2026 18:36
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