Generates comprehensive project documentation including README files, API docs, setup guides, contributing guidelines, and code documentation. Use when starting projects, preparing for open source, onboarding developers, or maintaining documentation.
Complete framework for creating clear, comprehensive project documentation that helps developers get started quickly.
Transforms code into accessible documentation:
node scripts/generate-readme.js package.json README.md
node scripts/create-api-docs.js src/ docs/api.md
node scripts/scaffold-docs.js project-name docs/
graph TD
A[Codebase] --> B[Analyze Structure]
B --> C[Generate README]
C --> D[Document APIs]
D --> E[Create Setup Guide]
E --> F[Write Contributing Guide]
F --> G[Add Code Comments]
G --> H[Generate Changelog]
H --> I[Review & Refine]
I --> J{Complete?}
J -->|No| B
J -->|Yes| K[Publish Docs]
style K fill:#99ff99
# Project Name
[]()
[]()
One-line description of what this project does.
## Features
- 🚀 Feature 1
- ✨ Feature 2
- 🎯 Feature 3
- 🔒 Feature 4
## Demo
**Live Demo**: [https://demo.example.com](https://demo.example.com)
## Quick Start
\`\`\`bash
# Clone repository
git clone https://github.com/username/project.git
cd project
# Install dependencies
npm install
# Set up environment variables
cp .env.example .env
# Edit .env with your values
# Run development server
npm run dev
\`\`\`
Visit [http://localhost:3000](http://localhost:3000)
## Installation
### Prerequisites
- Node.js 18+ ([Download](https://nodejs.org))
- PostgreSQL 14+ ([Download](https://postgresql.org))
- Git ([Download](https://git-scm.com))
### Step-by-Step Setup
1. **Clone the repository**
\`\`\`bash
git clone https://github.com/username/project.git
cd project
\`\`\`
2. **Install dependencies**
\`\`\`bash
npm install
\`\`\`
3. **Environment Configuration**
Create \`.env\` file:
\`\`\`env
DATABASE_URL=postgresql://user:password@localhost:5432/dbname
NEXT_PUBLIC_API_URL=http://localhost:3000/api
SECRET_KEY=your-secret-key
\`\`\`
4. **Database Setup**
\`\`\`bash
npm run db:migrate
npm run db:seed
\`\`\`
5. **Run Development Server**
\`\`\`bash
npm run dev
\`\`\`
## Usage
### Basic Example
\`\`\`typescript
import { createUser } from '@/lib/users';
const user = await createUser({
email: '[email protected]',
name: 'John Doe'
});
\`\`\`
### Advanced Features
[Link to detailed usage documentation]
## API Reference
See [API Documentation](docs/api.md) for complete API reference.
### Quick Reference
\`\`\`
GET /api/users - List users
POST /api/users - Create user
GET /api/users/:id - Get user
PATCH /api/users/:id - Update user
DELETE /api/users/:id - Delete user
\`\`\`
## Configuration
### Environment Variables
| Variable | Description | Required | Default |
|----------|-------------|----------|---------|
| \`DATABASE_URL\` | PostgreSQL connection string | Yes | - |
| \`API_KEY\` | Third-party API key | Yes | - |
| \`PORT\` | Server port | No | 3000 |
| \`NODE_ENV\` | Environment | No | development |
### Configuration Files
- \`next.config.js\` - Next.js configuration
- \`tsconfig.json\` - TypeScript settings
- \`.eslintrc.js\` - Linting rules
## Scripts
| Command | Description |
|---------|-------------|
| \`npm run dev\` | Start development server |
| \`npm run build\` | Build for production |
| \`npm start\` | Start production server |
| \`npm test\` | Run tests |
| \`npm run lint\` | Lint code |
| \`npm run format\` | Format code with Prettier |
## Project Structure
\`\`\`
project/
├── app/ # Next.js app directory
│ ├── (auth)/ # Authentication routes
│ ├── (dashboard)/ # Dashboard routes
│ └── api/ # API routes
├── components/ # React components
│ ├── ui/ # UI primitives
│ └── features/ # Feature components
├── lib/ # Utility functions
├── convex/ # Backend (Convex)
├── public/ # Static assets
├── docs/ # Documentation
└── tests/ # Test files
\`\`\`
## Technology Stack
- **Frontend**: Next.js 14, React, TypeScript
- **Backend**: Convex (serverless)
- **Database**: Convex (built-in)
- **Authentication**: Clerk
- **Styling**: Tailwind CSS, shadcn/ui
- **Deployment**: Vercel
## Contributing
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
### Quick Contribution Guide
1. Fork the repository
2. Create feature branch (\`git checkout -b feature/amazing-feature\`)
3. Commit changes (\`git commit -m 'Add amazing feature'\`)
4. Push to branch (\`git push origin feature/amazing-feature\`)
5. Open Pull Request
## Testing
\`\`\`bash
# Run all tests
npm test
# Run with coverage
npm run test:coverage
# Run specific test
npm test path/to/test.ts
\`\`\`
## Deployment
### Vercel (Recommended)
[](https://vercel.com/new/clone?repository-url=https://github.com/username/project)
### Manual Deployment
1. Build production bundle:
\`\`\`bash
npm run build
\`\`\`
2. Set environment variables in hosting platform
3. Deploy:
\`\`\`bash
npm start
\`\`\`
See [Deployment Guide](docs/deployment.md) for platform-specific instructions.
## Troubleshooting
### Common Issues
**Issue**: Database connection fails
**Solution**: Check \`DATABASE_URL\` format and database is running
**Issue**: Build errors with TypeScript
**Solution**: Run \`npm run type-check\` and fix type errors
See [Troubleshooting Guide](docs/troubleshooting.md) for more help.
## Roadmap
- [ ] Feature 1 (Q1 2024)
- [ ] Feature 2 (Q2 2024)
- [ ] Feature 3 (Q3 2024)
See [ROADMAP.md](ROADMAP.md) for detailed plans.
## License
This project is licensed under the MIT License - see [LICENSE](LICENSE) file.
## Acknowledgments
- [Library 1](https://github.com/...) - Description
- [Library 2](https://github.com/...) - Description
## Support
- **Documentation**: [https://docs.example.com](https://docs.example.com)
- **Issues**: [GitHub Issues](https://github.com/username/project/issues)
- **Discussions**: [GitHub Discussions](https://github.com/username/project/discussions)
- **Email**: [email protected]
## Contributors
Thanks to these wonderful people:
<!-- ALL-CONTRIBUTORS-LIST:START -->
[See all contributors](CONTRIBUTORS.md)
<!-- ALL-CONTRIBUTORS-LIST:END -->
---
**Made with ❤️ by [Your Name](https://github.com/username)**