Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/remove-docs-site-url.md
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .changeset/update-docs-app-references.md
Original file line number Diff line number Diff line change
@@ -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
12 changes: 6 additions & 6 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

---

Expand Down
6 changes: 3 additions & 3 deletions apps/www/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions apps/www/lib/config.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* 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'
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'
2 changes: 1 addition & 1 deletion packages/pixel-ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down