refactor(docs): consolidate and cleanup documentation
- Delete 9 deprecated/obsolete docs (~6,300 lines removed) - Move test PDFs to tests/fixtures/ocr-samples/ - Create docs/DEPLOYMENT.md as principal guide - Create tests/ocr-validation/README.md - Update all refs for ultrathin monolith architecture - Update OCR tests to use relative paths Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
31
README.md
31
README.md
@@ -88,7 +88,7 @@ This starts SSH tunnel, unified backend (port 8001), and frontend (port 3000).
|
||||
- **Shared Database Pool**: Singleton Oracle connection pool shared across all modules
|
||||
- **Two-Tier Cache System**: Hybrid L1 (Memory) + L2 (SQLite) for optimal performance
|
||||
- **JWT Authentication**: Secure token-based auth with middleware
|
||||
- **Microservices**: Independent services with clear separation of concerns
|
||||
- **Modular Architecture**: Independent modules with clear separation of concerns
|
||||
- **Oracle Integration**: Direct Oracle stored procedure calls with caching
|
||||
- **Responsive Design**: Mobile-friendly Vue.js interface
|
||||
- **Telegram Integration**: Alternative bot-based interface
|
||||
@@ -299,30 +299,27 @@ BACKEND_API_URL=http://localhost:8001
|
||||
|
||||
### Quick Reference
|
||||
- **`CLAUDE.md`** - Development guide for AI/Claude Code (architecture, cache system, common tasks, troubleshooting)
|
||||
- **`docs/ARCHITECTURE_SCHEMA.md`** - Architecture diagrams, cache system, and schemas
|
||||
- `docs/MICROSERVICES_GUIDE.md` - Microservices architecture details
|
||||
- `DEVELOPMENT_BLUEPRINT.md` - Detailed development plan
|
||||
- **`docs/ARCHITECTURE-DECISIONS.md`** - Architecture Decision Records (ADRs)
|
||||
- **`docs/MONOLITH_ARCHITECTURE.md`** - Ultrathin monolith architecture details
|
||||
|
||||
### Component-Specific
|
||||
- `README.md` - Main application README
|
||||
- `backend/ modules and CLAUDE.md` - Backend specifics
|
||||
- `src/ and docs/MONOLITH_ARCHITECTURE.md` - Frontend guide
|
||||
- `E2E testing guide in docs/` - Frontend testing
|
||||
- `backend/modules/telegram/README.md` - Telegram bot guide
|
||||
- `backend/modules/telegram/TELEGRAM_COMMANDS.md` - Bot commands
|
||||
### Module Documentation
|
||||
- `docs/data-entry/DATA-ENTRY-MODULE.md` - Data Entry module (SQLModel, workflow, OCR)
|
||||
- `docs/telegram/README.md` - Telegram bot integration
|
||||
- `docs/telegram/DEPLOYMENT.md` - Telegram single-worker requirement
|
||||
|
||||
### Frontend Styling & CSS
|
||||
- `docs/ONBOARDING_CSS.md` - CSS system onboarding guide (start here!)
|
||||
- `docs/CSS_PATTERNS.md` - Comprehensive CSS patterns library
|
||||
- `docs/DESIGN_TOKENS.md` - Design tokens reference (colors, spacing, typography)
|
||||
- `docs/STYLING_GUIDELINES.md` - CSS best practices and conventions
|
||||
- `docs/COMPONENT_STYLING.md` - Component-specific styling guide
|
||||
- `docs/FORM_TEMPLATE.md` - Standardized form template and patterns
|
||||
- `docs/MOBILE_PATTERNS.md` - Mobile UI patterns and components
|
||||
|
||||
### Deployment
|
||||
- `DEPLOYMENT_GUIDE.md` - Production deployment (Linux & Windows)
|
||||
- `deployment/windows/README.md` - Windows quick start
|
||||
- `deployment/windows/docs/WINDOWS_DEPLOYMENT.md` - Complete Windows guide
|
||||
- **`docs/DEPLOYMENT.md`** - Principal deployment guide (start here!)
|
||||
- `deployment/linux/README.md` - Deploy from Linux/LXC
|
||||
- `deployment/windows/README.md` - Deploy from Windows
|
||||
|
||||
### Testing
|
||||
- `tests/ocr-validation/README.md` - OCR validation tests
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user