Skip to content

feat(docs): restyle docs with the dashboard design system - #950

Draft
RapidPoseidon wants to merge 1 commit into
mainfrom
feat(docs)/dashboard-design-system
Draft

RapidPoseidon wants to merge 1 commit into
mainfrom
feat(docs)/dashboard-design-system

Conversation

@RapidPoseidon

Copy link
Copy Markdown
Contributor

Why

The SDK docs look like a separate product: Inter, top tabs, a gray Material palette and a gradient Login button. The new dashboard at app.rapidata.ai has its own design system (app-frontend/packages/ui/theme.css). This brings the docs onto it, so the "Documentation" link from the dashboard's Help page lands somewhere that looks like the app. It's also the first step toward a ClickHouse/Mintlify-style docs site with an AI chat panel.

Decisions

  • Theme through Material's CSS variables, not by rewriting components. Most of the change remaps --md-* variables to the dashboard tokens (same names and values as theme.css). That keeps the override small and less likely to break on Material upgrades.
  • Sidebar groups instead of top tabs. This matches the dashboard and ClickHouse layout. navigation.indexes and section-index are dropped so each group's "Overview" stays a visible link and isn't folded into the group label. Page URLs don't change.
  • primary: custom. Material's black palette paints the header its own gray at higher specificity than our CSS.

Verified

  • Built locally with mkdocs build; tests/test_docs_site.py passes.
  • Screenshotted the home, quickstart, audiences, API reference, search (Ctrl+K) and mobile layouts against the live dashboard.

Nothing the agent skill documents changed: this PR touches styling and nav only.

🔗 Session: session-8ada15fe

🤖 Generated with Claude Code

Map the app-frontend dashboard tokens onto MkDocs Material: Red Hat Display,
the neutral canvas and card surfaces, hairline borders, filled sidebar rows,
and a Ctrl/Cmd+K search shortcut. Top tabs move into sidebar groups.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: elias@rapidata.ai <198448439+EliasTeikari@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown

⚠ Agent skill not updated

This PR does not modify src/rapidata/_skill/. That directory is the agent skill that ships in every SDK release and that coding agents read through python -m rapidata skill.

Before merging, pick one:

  1. The change affects what an agent needs to know (new or renamed API, changed parameter, default or result field, new gotcha): update src/rapidata/_skill/SKILL.md (or a companion guide next to it) in this PR.
  2. Nothing the skill documents changed: a reviewer applies the skill-unchanged-approved label. New commits remove the label again.

@RapidPoseidon

Copy link
Copy Markdown
Contributor Author

The Agent Skill check is red by design: this PR only changes docs styling and nav (docs/stylesheets/extra.css, docs/js/search-shortcut.js, mkdocs.yml), so nothing the agent skill documents changed. A reviewer needs to apply skill-unchanged-approved to clear it. Every other check (build, test, type-check, Check skill update) is green.

This branch has not been deployed

No deployments
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