Welcome to the underwrite documentation. This platform provides a nano-service architecture for delegated underwriting in unsecured lending.
- Getting Started — 5-minute setup
- Architecture Overview — System design and components
- API Reference — Public interfaces and services
- Installation Guide — System requirements and setup
docs/
├── README.md ← You are here
├── INDEX.md ← Master navigation
├── ARCHITECTURE.md ← High-level architecture
├── SYSTEM_DESIGN.md ← Runtime behavior & data flow
├── DIRECTORY_STRUCTURE.md ← File system layout
├── DESIGN_DECISIONS.md ← Architectural choices
├── DOMAIN_MODEL.md ← Core entities & business rules
├── API.md ← Public interfaces & services
├── CONFIGURATION.md ← Configuration system
├── ENVIRONMENT_VARIABLES.md← Complete env var reference
├── INSTALLATION.md ← Setup instructions
├── QUICKSTART.md ← 5-minute guide
├── DEVELOPMENT.md ← Local workflow & tooling
├── BUILD.md ← Build & packaging
├── TESTING.md ← Test suite guide
├── DEBUGGING.md ← Debugging workflows
├── DEPLOYMENT.md ← Production deployment
├── OPERATIONS.md ← Operational procedures
├── OBSERVABILITY.md ← Logging, metrics, tracing
├── PERFORMANCE.md ← Performance characteristics
├── SECURITY.md ← Security model
├── DATABASE.md ← Database schema & patterns
├── MIGRATIONS.md ← Migration strategy
├── DEPENDENCIES.md ← Dependency reference
├── TROUBLESHOOTING.md ← Common issues & fixes
├── FAQ.md ← Frequently asked questions
├── CONTRIBUTING.md ← How to contribute
├── CODE_STYLE.md ← Coding standards
├── RELEASE_PROCESS.md ← Release workflow
├── CHANGELOG_GUIDE.md ← Changelog maintenance
├── MAINTENANCE.md ← Long-term maintenance
├── ROADMAP.md ← Future plans
├── GLOSSARY.md ← Terminology
└── ADR/ ← Architecture Decision Records
└── README.md
- README.md — Project overview
- CHANGELOG.md — Release history
- CONTRIBUTING.md — How to contribute
- SECURITY.md — Security policy
- LICENSE — MIT License