Redesign Logo

Documentation

Sidebar style docs for contributors

Redesign is a searchable library of design specs for Stitch. This page explains the contribution workflow, file format, and the exact commands needed to keep submissions clean and deploy-ready.

Getting started

Clone the repository, install dependencies with Bun, and run the local development server.

git clone https://github.com/YOUR_USERNAME/redesign.git
cd redesign
bun install
bun run dev

Local server: http://localhost:3000

Project structure

These folders and files cover most contribution work.

app/ - Application routes and pages

app/docs/page.tsx - Documentation page

designs/ - Markdown design specs

scripts/generate-index.ts - Search index + sitemap generation

src/generated/designs.json - Generated catalog data

Add a design

Add markdown files in either a single slug format or an author folder format.

designs/landing-page.md
designs/jane-doe/analytics-dashboard.md

Then regenerate and verify locally.

bun run generate
bun run dev

Design format

Keep specs structured and scannable so they are easy to reuse in AI design tools.

Recommended sections

  • Design System Overview
  • Color System
  • Typography
  • Layout
  • Components
  • Responsive Behavior
  • Interactions

Writing tips

  • Use specific values and consistent naming
  • Keep paragraphs short and intent-driven
  • Document hover, focus, and empty states
  • Favor reusable patterns over one-off wording
  • Validate readability before opening a PR

Commands

Core scripts used in this project.

CommandPurpose
bun run devStart local development
bun run generateRebuild index and sitemap
bun run buildCreate production build
bun run startRun production server

Contribution checklist

  • Use kebab-case names for all design files
  • Keep markdown sectioned and easy to scan
  • Run bun run generate before creating a PR
  • Confirm new routes render correctly in dev
  • Keep copy concise and implementation-focused
Back to libraryOpen GitHub