From 932b26553a55e5f4fb87c9404f544c2261d64fdc Mon Sep 17 00:00:00 2001 From: Joaquin Diaz Date: Sat, 7 Feb 2026 11:22:34 -0300 Subject: [PATCH 1/2] Clarify docs app scope and homepage URL --- CLAUDE.md | 12 ++++++------ CONTRIBUTING.md | 4 ++-- README.md | 2 +- apps/www/README.md | 6 +++--- apps/www/lib/config.ts | 2 +- packages/pixel-ui/package.json | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 719390d..33dfea7 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -7,13 +7,13 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co Pixel UI is a pixel-art styled React component library built on [Base UI](https://base-ui.com) with Tailwind CSS v4. This is a pnpm monorepo containing: - `packages/pixel-ui` - The component library (published to npm as `@joacod/pixel-ui`) -- `apps/www` - Documentation site built with Next.js and Fumadocs +- `apps/www` - Documentation app built with Next.js and Fumadocs (local development only) ## Essential Commands ```bash # Development -pnpm dev # Run docs site with hot reload +pnpm dev # Run docs app locally with hot reload pnpm build # Build everything (library + docs) pnpm build:lib # Build library only pnpm build:docs # Build docs only @@ -116,7 +116,7 @@ pnpm changeset ### Version Synchronization -**IMPORTANT:** When asked about complete or improve current changesets that bump the `@joacod/pixel-ui` version, you MUST update the documentation site version reference: +**IMPORTANT:** When asked about complete or improve current changesets that bump the `@joacod/pixel-ui` version, you MUST update the documentation app version reference: 1. **After creating a library changeset** that changes the version (major/minor/patch) 2. **Update** `apps/www/lib/config.ts` → Change `LIBRARY_VERSION` to match the new version @@ -164,7 +164,7 @@ Design tokens exist in **two places**: These should be kept in sync. The CSS version is the source of truth for Tailwind utilities. -**Note:** Design tokens are primarily for **internal use** by the library. The colors/sizes/spacing exports exist mainly for the documentation site and edge cases. Users should rely on the `variant` and `size` props rather than importing tokens directly. +**Note:** Design tokens are primarily for **internal use** by the library. The colors/sizes/spacing exports exist mainly for the documentation app and edge cases. Users should rely on the `variant` and `size` props rather than importing tokens directly. ### Styling Architecture (Tailwind v4) @@ -317,9 +317,9 @@ When adding new components: - Variant and Size types are centralized in `src/styles/tokens.ts` - Props interfaces should extend `PixelComponentBaseProps` or include standard props (variant, size, disabled, className) -### Documentation Site +### Documentation App -- Built with Next.js 15 and Fumadocs +- Built with Next.js 15 and Fumadocs (local development only, not deployed) - MDX content in `apps/www/content/docs/` - Automatically imports and showcases components from `@joacod/pixel-ui` - Run with `pnpm dev` from root diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2aeb4f8..22304bc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,7 +38,7 @@ Thank you for your interest in contributing to Pixel UI! We welcome contribution 3. Test your changes: ```bash - # Run docs site with hot reload + # Run docs app locally pnpm dev # Type check @@ -91,7 +91,7 @@ pixel-ui/ │ ├── dist/ # Built files (published to npm) │ └── package.json # Published as @joacod/pixel-ui └── apps/ - └── www/ # Documentation site + └── www/ # Documentation app (local dev) ├── app/ # Next.js app └── content/ # MDX documentation ``` diff --git a/README.md b/README.md index b527574..6ce5614 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Opinionated pixel-art styled React component library built on [Base UI](https:// This is a monorepo containing: - **packages/pixel-ui** - The component library (published to npm) -- **apps/www** - Documentation site +- **apps/www** - Documentation and component previews (local development) --- diff --git a/apps/www/README.md b/apps/www/README.md index c17bb4d..60c22f1 100644 --- a/apps/www/README.md +++ b/apps/www/README.md @@ -1,8 +1,8 @@ -# 👾 Pixel UI Documentation Site +# 👾 Pixel UI Documentation App -The official documentation site for Pixel UI, built with [Fumadocs](https://fumadocs.dev) and Next.js. +Local documentation and component preview app for Pixel UI, built with [Fumadocs](https://fumadocs.dev) and Next.js. -This site serves as both the documentation and a live showcase of the Pixel UI component library. +This app serves as both the documentation and a live showcase of the Pixel UI component library during local development. ## Development diff --git a/apps/www/lib/config.ts b/apps/www/lib/config.ts index 3d4bfff..8ad0906 100644 --- a/apps/www/lib/config.ts +++ b/apps/www/lib/config.ts @@ -1,5 +1,5 @@ /** - * Configuration for the documentation site + * Configuration for the documentation app * Update LIBRARY_VERSION when publishing new versions of @joacod/pixel-ui */ export const LIBRARY_VERSION = '0.13.0' diff --git a/packages/pixel-ui/package.json b/packages/pixel-ui/package.json index 31049c2..bdedc40 100644 --- a/packages/pixel-ui/package.json +++ b/packages/pixel-ui/package.json @@ -44,7 +44,7 @@ "type": "git", "url": "git+https://github.com/joacod/pixel-ui.git" }, - "homepage": "https://pixel-ui.joacod.com/", + "homepage": "https://github.com/joacod/pixel-ui", "bugs": { "url": "https://github.com/joacod/pixel-ui/issues" }, From fab364fb9a39de1f1070ef4c177c24453a37ddb6 Mon Sep 17 00:00:00 2001 From: Joaquin Diaz Date: Sat, 7 Feb 2026 11:24:58 -0300 Subject: [PATCH 2/2] Add docs changesets and sync version badge --- .changeset/remove-docs-site-url.md | 7 +++++++ .changeset/update-docs-app-references.md | 8 ++++++++ apps/www/lib/config.ts | 2 +- 3 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .changeset/remove-docs-site-url.md create mode 100644 .changeset/update-docs-app-references.md diff --git a/.changeset/remove-docs-site-url.md b/.changeset/remove-docs-site-url.md new file mode 100644 index 0000000..dd5ed53 --- /dev/null +++ b/.changeset/remove-docs-site-url.md @@ -0,0 +1,7 @@ +--- +'@joacod/pixel-ui': patch +--- + +Update homepage URL to point to GitHub repository + +- Changed homepage from `pixel-ui.joacod.com` to GitHub repo URL since the documentation site is no longer deployed diff --git a/.changeset/update-docs-app-references.md b/.changeset/update-docs-app-references.md new file mode 100644 index 0000000..e75175a --- /dev/null +++ b/.changeset/update-docs-app-references.md @@ -0,0 +1,8 @@ +--- +'www': patch +--- + +Clarify documentation app is for local development only + +- Updated references from "Documentation site" to "Documentation app" across README, config, and contributor docs +- Removed implication of a deployed documentation site diff --git a/apps/www/lib/config.ts b/apps/www/lib/config.ts index 8ad0906..ebb89e5 100644 --- a/apps/www/lib/config.ts +++ b/apps/www/lib/config.ts @@ -2,6 +2,6 @@ * Configuration for the documentation app * Update LIBRARY_VERSION when publishing new versions of @joacod/pixel-ui */ -export const LIBRARY_VERSION = '0.13.0' +export const LIBRARY_VERSION = '0.13.2' export const NPM_PACKAGE_URL = 'https://www.npmjs.com/package/@joacod/pixel-ui' export const GITHUB_REPO_URL = 'https://github.com/joacod/pixel-ui'