shancheas
0b0bdd9c4b
- Introduced backend patterns skill with guidelines on API design, database optimization, and server-side best practices. - Added coding standards skill outlining universal coding principles for TypeScript, NestJS, and Node.js development. - Implemented continuous learning skill to automatically extract reusable patterns from Cursor sessions. - Created NestJS best practices skill detailing architecture patterns, dependency injection, error handling, and security measures. - Included various rules and templates for NestJS best practices to ensure production-ready applications.
32 lines
731 B
Markdown
32 lines
731 B
Markdown
# Update Documentation
|
|
|
|
Sync documentation from source-of-truth:
|
|
|
|
1. Read package.json scripts section
|
|
- Generate scripts reference table
|
|
- Include descriptions from comments
|
|
|
|
2. Read .env.example
|
|
- Extract all environment variables
|
|
- Document purpose and format
|
|
|
|
3. Generate docs/CONTRIB.md with:
|
|
- Development workflow
|
|
- Available scripts
|
|
- Environment setup
|
|
- Testing procedures
|
|
|
|
4. Generate docs/RUNBOOK.md with:
|
|
- Deployment procedures
|
|
- Monitoring and alerts
|
|
- Common issues and fixes
|
|
- Rollback procedures
|
|
|
|
5. Identify obsolete documentation:
|
|
- Find docs not modified in 90+ days
|
|
- List for manual review
|
|
|
|
6. Show diff summary
|
|
|
|
Single source of truth: package.json and .env.example
|