Skip to content

Align docs.bump.sh with the new API documentation theme - #496

Merged
scharrier merged 11 commits into
mainfrom
ui-theme-refresh-and-fixes
Sep 28, 2026
Merged

scharrier merged 11 commits into
mainfrom
ui-theme-refresh-and-fixes

Conversation

@scharrier

@scharrier scharrier commented Sep 27, 2026 •

Copy link
Copy Markdown
Member

Our API documentation portals got a new UI. This PR rebuilds docs.bump.sh on the same foundations (Inter, zinc neutrals, one accent, hairlines, light and dark modes) so the help center, guides and product updates read as one product with the API docs.

Along the way: a real home page with search and an /llms.txt index, search results rendered like the API reference, a data-driven FAQ with FAQPage JSON-LD, and stale content fixed (no free plan, Arazzo supported, footer links checked).

@netlify

netlify Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for bump-content-hub ready!

Name Link
🔨 Latest commit 05149e0
🔍 Latest deploy log https://app.netlify.com/projects/bump-content-hub/deploys/6aba37e35be7a40009f4b4cf
😎 Deploy Preview https://deploy-preview-496--bump-content-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@scharrier
scharrier requested a review from grossyoan September 27, 2026 20:24
@scharrier
scharrier force-pushed the ui-theme-refresh-and-fixes branch from 77d0432 to 88c7c8b Compare September 28, 2026 06:22
@grossyoan

Copy link
Copy Markdown
Contributor

That's a great enhancement! I honestly don't have a lot of feedback.

A few things that I saw:

  • We might want to harmonize the search bar with the others by adding a search icon as well
    image
  • We might want to make buttons stand out more (and more than links)
    image

The site now shares the Bump.sh API documentation theme: Inter and
JetBrains Mono, zinc neutrals, one accent, hairlines, light and dark
modes. Styles are rebuilt from scratch in cascade layers with design
tokens, the markup is simplified, and mobile navigation uses drawers.
Dates share one helper and one style, guide sidebars are quieter.
A small Lit subclass of bridgetown-quick-search renders the results
grouped by collection under uppercase headings, as quiet hoverable rows
with a title and a one-line preview, styled with the site tokens.
@scharrier
scharrier force-pushed the ui-theme-refresh-and-fixes branch from 88c7c8b to 94d812f Compare September 28, 2026 09:38
Cmd/Ctrl+K focuses the search input through a Stimulus controller.
The copy controller gains a text action that copies a parameter and
flags the button as copied for a moment.
The home presents every area of the site: a hero with search and the
latest product update, two get started paths with their CLI command,
the help center sections, product updates, guides, developer and agent
resources, and support links. /llms.txt indexes every page for agents.
The old redirect from / to /help/ is removed.
Markdown tables were display: block to scroll horizontally, which made
them shrink to their content. An inspector now wraps each table in a
scroll container so the table itself keeps its layout at 100%.
Previous, page count and next share one grid row. Both links are always
rendered, disabled when there is no target, so the row keeps its shape.
Questions live in src/_data/faq.yml, grouped by theme, each answer
opening with a direct statement and linking to the page that covers
it. The page renders native details/summary rows and emits FAQPage
JSON-LD built from the same data.
There is no free plan anymore: the CTA button and a guide now point to
the 14-day free trial that every new account starts with.
Arazzo is supported, so the getting started pages no longer announce
it. The MCP deploy page documents the real CLI command instead of a
TBD. Ask AI lists five tools and its Claude row no longer says ChatGPT,
the support email label matches its link, billing lists two VAT cases.
Product lists API documentation, MCP platform, Pricing and API Diff.
Specifications point to the docs pages for OpenAPI, AsyncAPI, Arazzo
and Flower. Resources gains About, the bottom row Cookie policy and
Security. Social links follow bump.sh: GitHub, Bluesky, Mastodon and
LinkedIn. Every link was checked for a 200 response.
@scharrier
scharrier force-pushed the ui-theme-refresh-and-fixes branch from 94d812f to 05149e0 Compare September 28, 2026 09:48
@scharrier

Copy link
Copy Markdown
Member Author

Thanks for the feedback @grossyoan, 2 issues fixed 👍

@scharrier
scharrier merged commit 53c9804 into main Sep 28, 2026
5 checks passed
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