13 lines
950 B
Markdown
13 lines
950 B
Markdown
# Fix README inaccuracies and add missing setup documentation
|
|
|
|
## Overview
|
|
|
|
The README.md contains outdated/incorrect information: 1) States 'Vite' as build tool but project uses Next.js 15.1.0, 2) Shows 'npm install' commands but project uses pnpm (pnpm-lock.yaml exists), 3) Has Dockerfile and docker-compose.yml but no Docker deployment instructions, 4) Missing explanation of the 6 environment variables (NEXT_PUBLIC_SUPABASE_URL, NEXT_PUBLIC_SUPABASE_ANON_KEY, NEXT_PUBLIC_GA_TRACKING_ID, NEXT_PUBLIC_SITE_URL, OPENAI_API_KEY, NODE_ENV) beyond what's in .env.example.
|
|
|
|
## Rationale
|
|
|
|
The README is the primary entry point for any developer. Incorrect build tool information and wrong package manager commands create immediate friction for onboarding. Docker deployment is available but completely undocumented, leaving a significant deployment option unexplained.
|
|
|
|
---
|
|
*This spec was created from ideation and is pending detailed specification.*
|