mirror of
https://github.com/pacnpal/thrillwiki_django_no_react.git
synced 2025-12-20 14:51:08 -05:00
d504d41de2
- Add complete backend/ directory with full Django application - Add frontend/ directory with Vite + TypeScript setup ready for Next.js - Add comprehensive shared/ directory with: - Complete documentation and memory-bank archives - Media files and avatars (letters, park/ride images) - Deployment scripts and automation tools - Shared types and utilities - Add architecture/ directory with migration guides - Configure pnpm workspace for monorepo development - Update .gitignore to exclude .django_tailwind_cli/ build artifacts - Preserve all historical documentation in shared/docs/memory-bank/ - Set up proper structure for full-stack development with shared resources
43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# ThrillWiki Documentation
|
|
|
|
This directory contains comprehensive documentation for the ThrillWiki monorepo.
|
|
|
|
## 📁 Structure
|
|
|
|
- [`api/`](./api/) - API documentation and specifications
|
|
- [`deployment/`](./deployment/) - Deployment guides and configurations
|
|
- [`development/`](./development/) - Development setup and workflows
|
|
|
|
## 📖 Quick Links
|
|
|
|
### For Developers
|
|
- [Development Setup](./development/setup.md)
|
|
- [API Documentation](./api/)
|
|
- [Contributing Guide](../README.md#contributing)
|
|
|
|
### For DevOps
|
|
- [Deployment Guide](./deployment/)
|
|
- [Docker Configuration](../config/docker/)
|
|
- [CI/CD Setup](../config/ci/)
|
|
|
|
### For Architects
|
|
- [Architecture Overview](../../architecture/)
|
|
- [Monorepo Structure](../../architecture/monorepo-structure-plan.md)
|
|
- [Migration Guide](../../architecture/migration-mapping.md)
|
|
|
|
## 🔄 Keeping Documentation Updated
|
|
|
|
Documentation should be updated alongside code changes:
|
|
|
|
1. API changes → Update API docs
|
|
2. New features → Update user guides
|
|
3. Infrastructure changes → Update deployment docs
|
|
4. Process changes → Update development guides
|
|
|
|
## 📝 Documentation Standards
|
|
|
|
- Use Markdown format
|
|
- Include code examples where applicable
|
|
- Keep explanations clear and concise
|
|
- Update table of contents when adding new sections
|
|
- Use relative links for internal references |