Skip to content

New docs home page #4289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 29 commits into
base: main
Choose a base branch
from
Draft

Conversation

Blargian
Copy link
Member

@Blargian Blargian commented Aug 16, 2025

Summary

New design for the docs homepage

  • Give the page visual hierarchy for a more pleasing look and feel
  • Make search and Ask AI the first thing you see
  • Add quick links to change logs with current version shown (automatically updated on build)
  • Add 3 cards which give the user a simple path to follow
  • Update migration logos to link to ClickPipes where appropriate

Still to do:

  • Early feedback (planned for Tuesday 19 August)
  • Design for images and design review
  • Select menu items for get started, learn and reference
  • Add a "Featured" section from which we can feature new docs content

Address feedback:

  • The search dialog is showing a dark blue background — it should use colors to mimic our standard dark theme colors.

  • The icons on Get Started, Learn, and Reference don’t work well as illustrations (they’re also pixelated). Removing them might make the layout cleaner.

  • There’s low contrast between the Integrations square and the Migrate background color.

  • The Feature badges should use capital case instead of ALL CAPS.

  • The body text on the Feature cards should use a muted white/gray color for better readability.

  • For cards in general, we could add a light gray stroke to match the styling of the menu items.

  • The page width is currently ~980px. We might want to consider increasing it slightly.

  • Search and Ask AI look connected, almost as if the user should type and then click Ask AI to “search” (not intended). Consider adding an “or” between search and Ask AI.

  • Spacing should be the same for the list items in "reference" as it is for "getting started" and "learn".

  • Use 14px or 16px and font Inter. Consistency of heading sizes between cards.

  • Possibly add both Cloud quick start + OSS quick start links to "Getting started" list. It wasn't clear why Cloud getting started is linked in addition to ClickHouse Cloud (get started section) as well.

  • Example datasets -> “Sample datasets” (to imply they can be downloaded).

  • Styling of cards, buttons, links etc consistent with the website.

  • Consider making the migrations section span 3 columns rather than 2. The changelogs could maybe just be text with a small icon, not needed to display them so prominently.

Checklist

Copy link

vercel bot commented Aug 16, 2025

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 16, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Updated (UTC)
clickhouse-docs Ready Ready Preview Aug 21, 2025 9:46am

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.

1 participant