Skip to content

feat(storybook): consolidate docs into Storybook, remove fumadocs#112

Merged
yahyafakhroji merged 2 commits into
mainfrom
chore/remove-fumadocs-consolidate-storybook-docs
Jun 4, 2026
Merged

feat(storybook): consolidate docs into Storybook, remove fumadocs#112
yahyafakhroji merged 2 commits into
mainfrom
chore/remove-fumadocs-consolidate-storybook-docs

Conversation

@yahyafakhroji

@yahyafakhroji yahyafakhroji commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Migrate all hand-written usage documentation from the undeployed fumadocs app (apps/docs) into Storybook, then remove fumadocs so Storybook is the single, published documentation surface.

  • Enable @storybook/addon-docs and MDX doc pages
  • Fold every base & feature component's usage prose + examples into its story (parameters.docs.description + example stories)
  • Add MDX guide pages: Introduction, Installation, Theming, Providers, and the Picker migration guide
  • Add hook docs with live demos: useCopyToClipboard, useDebounce
  • Add stories for previously undocumented components: StatCard, Combobox, Sidebar
  • Theme-aware DocsContainer so docs pages follow dark mode
  • Multi package-manager install snippets (npm/pnpm/yarn/bun)
  • Point README docs references at Storybook; drop @repo/docs from the changeset ignore list
  • Remove apps/docs (fumadocs) — it had no Dockerfile, publish workflow, or kustomize bundle, and only added CI weight

Scope

  • 2 commits · 169 files · +5,626 / −11,380
  • No change to the published @datum-cloud/datum-ui package → no changeset / version bump needed

Test plan

  • pnpm turbo build lint typecheck test — green (7/7)
  • pnpm --filter @repo/storybook build — succeeds
  • Parity audit: all 72 source MDX files represented in Storybook before deletion
  • Visual: pnpm --filter @repo/storybook dev — spot-check component Docs tabs + guide pages render in light & dark

Enable hand-authored documentation in Storybook and migrate all usage
docs from the (now removed) fumadocs app:

- Add @storybook/addon-docs and enable MDX doc pages
- Fold every base and feature component's usage prose and examples into
  its story (parameters.docs.description + example stories)
- Add MDX guide pages: Introduction, Installation, Theming, Providers,
  and the Picker migration guide
- Add useCopyToClipboard / useDebounce hook docs with live demos
- Add stories for previously undocumented components (StatCard,
  Combobox, Sidebar)
- Theme-aware DocsContainer so docs pages follow dark mode
- Multi package-manager install snippets (npm/pnpm/yarn/bun)
- Point README docs references at Storybook; drop @repo/docs from the
  changeset ignore list
The fumadocs docs site was never deployed (no Dockerfile, publish
workflow, or kustomize bundle) and only added build/lint/typecheck
weight to CI. All of its documentation now lives in Storybook, the
single published documentation surface.
@yahyafakhroji yahyafakhroji self-assigned this Jun 4, 2026
@yahyafakhroji yahyafakhroji requested a review from a team June 4, 2026 09:35
@yahyafakhroji yahyafakhroji merged commit 86d9905 into main Jun 4, 2026
8 checks passed
@yahyafakhroji yahyafakhroji deleted the chore/remove-fumadocs-consolidate-storybook-docs branch June 4, 2026 09:55
yahyafakhroji added a commit that referenced this pull request Jun 4, 2026
… to 1.1.0

PR #112 consolidated all docs into Storybook but shipped without a
changeset. Add a major changeset for that work and align the package
version with the latest Storybook release (1.1.0) so the next release
bumps from the correct base (-> 2.0.0).
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