Skip to content

docs(storybook): replace welcome banner with Introduction and System Principles content#3568

Merged
eliseo-juan merged 1 commit intomainfrom
docs/storybook-welcome-content
Mar 26, 2026
Merged

docs(storybook): replace welcome banner with Introduction and System Principles content#3568
eliseo-juan merged 1 commit intomainfrom
docs/storybook-welcome-content

Conversation

@eliseo-juan
Copy link
Copy Markdown
Contributor

@eliseo-juan eliseo-juan commented Mar 2, 2026

🚪 Why?

Problem

The Storybook welcome page displayed a banner redirecting users to the external documentation site (f0.factorial.dev). This created friction for developers who expected to see useful information directly in Storybook.

🔑 What?

Changes

  • Replaced the WelcomeMessage redirect banner with actual documentation content
  • Added "Introduction" section (What is f0?, Why f0?)
  • Added "System Principles" section (5 core principles)
  • Content matches the official f0 documentation site

✅ Verification

Manual Verification

  • Storybook welcome page now displays the Introduction and System Principles content directly
  • No more redirect banner to external site

Note

Low Risk
Low risk documentation-only change affecting the Storybook intro page content; no runtime logic or API behavior changes.

Overview
Replaces the Storybook welcome/redirect banner on Introduction.mdx (and removes the WelcomeMessage usage) with in-Storybook documentation content.

Adds an Introduction section (what/why f0) and a System Principles section outlining five core principles, and sets the page meta title via @storybook/addon-docs/blocks Meta.

Written by Cursor Bugbot for commit 8e082d2. This will update automatically on new commits. Configure here.

Copilot AI review requested due to automatic review settings March 2, 2026 16:22
@eliseo-juan eliseo-juan requested a review from a team as a code owner March 2, 2026 16:22
@github-actions github-actions bot added docs react Changes affect packages/react labels Mar 2, 2026
Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

@@ -1,6 +1,53 @@
import { Meta, Unstyled } from "@storybook/addon-docs/blocks"
import { WelcomeMessage } from "./components/Welcome"
import { Meta } from "@storybook/addon-docs/blocks";
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Unused WelcomeMessage component file not cleaned up

Low Severity

The WelcomeMessage import from ./components/Welcome was removed, but packages/react/docs/components/Welcome.tsx still exists in the repo with no remaining consumers. This file is now dead code that could confuse future developers.

Additional Locations (1)

Fix in Cursor Fix in Web

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the React package Storybook “Introduction” docs page to show first-party documentation content directly in Storybook instead of a welcome/redirect banner, reducing friction for developers browsing the design system.

Changes:

  • Replaced the previous Welcome banner usage with “Introduction” and “System Principles” documentation content.
  • Simplified the MDX imports to only what’s needed for the page metadata.
Comments suppressed due to low confidence (2)

packages/react/docs/Introduction.mdx:1

  • Import line ends with a semicolon, but this package’s formatting config sets semi: false and most docs MDX files omit semicolons. Please remove the semicolon to match repo formatting and avoid formatter churn.
import { Meta } from "@storybook/addon-docs/blocks";

packages/react/docs/Introduction.mdx:33

  • This page introduces a second H1 (# System Principles) after the initial # Introduction. Other docs pages in this folder use a single H1 per page; having multiple H1s can confuse the Docs TOC/heading hierarchy. Consider making “System Principles” an H2 (##) and shifting the numbered principles down one level (###).
---

# System Principles

f0's principles guide how we build and use our design system to create coherent user experiences across all Factorial products.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 2, 2026

✅ No New Circular Dependencies

No new circular dependencies detected. Current count: 0

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 2, 2026

📦 Alpha Package Version Published

Use pnpm i github:factorialco/f0#npm/alpha-pr-3568 to install the package

Use pnpm i github:factorialco/f0#cce447942ca884bb780197145ef06756dd64e39e to install this specific commit

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 2, 2026

🔍 Visual review for your branch is published 🔍

Here are the links to:

@eliseo-juan eliseo-juan merged commit 161d802 into main Mar 26, 2026
26 checks passed
@eliseo-juan eliseo-juan deleted the docs/storybook-welcome-content branch March 26, 2026 15:05
mjh-sakh pushed a commit that referenced this pull request Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs react Changes affect packages/react

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants