55 lines
2.1 KiB
Markdown
55 lines
2.1 KiB
Markdown
|
# DBIS Core Lite - Documentation
|
||
|
|
|
||
|
|
Welcome to the DBIS Core Lite documentation. This directory contains all project documentation organized by category.
|
||
|
|
|
||
|
|
## Quick Links
|
||
|
|
|
||
|
|
- [Architecture Overview](architecture.md)
|
||
|
|
- [API Reference](api/reference.md)
|
||
|
|
- [Deployment Guide](deployment/deployment.md)
|
||
|
|
- [Operations Runbook](operations/runbook.md)
|
||
|
|
- [Export Feature](features/exports/overview.md)
|
||
|
|
|
||
|
|
## Documentation Structure
|
||
|
|
|
||
|
|
### Architecture
|
||
|
|
- [System Architecture](architecture.md) - Complete system architecture documentation
|
||
|
|
|
||
|
|
### API
|
||
|
|
- [API Reference](api/reference.md) - Complete API documentation
|
||
|
|
|
||
|
|
### Deployment
|
||
|
|
- [Deployment Guide](deployment/deployment.md) - Production deployment instructions
|
||
|
|
- [Disaster Recovery](deployment/disaster-recovery.md) - Disaster recovery procedures
|
||
|
|
- [Test Database Setup](deployment/test-database-setup.md) - Test environment setup
|
||
|
|
- [Starting the Server](deployment/start-server.md) - Server startup guide
|
||
|
|
- [Package Update Guide](deployment/package-update-guide.md) - Dependency update procedures
|
||
|
|
|
||
|
|
### Operations
|
||
|
|
- [Runbook](operations/runbook.md) - Operations runbook for day-to-day management
|
||
|
|
|
||
|
|
### Features
|
||
|
|
- [Export Functionality](features/exports/overview.md) - FIN file export implementation
|
||
|
|
- [Testing](features/exports/testing.md) - Export testing documentation
|
||
|
|
- [Next Steps](features/exports/next-steps.md) - Future improvements and enhancements
|
||
|
|
- [Implementation Summary](features/implementation-summary.md) - Overall implementation summary
|
||
|
|
|
||
|
|
### Changelog
|
||
|
|
- [Archive](changelog/archive/) - Historical status and summary documents
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
1. **New to the project?** Start with [Architecture](architecture.md) and [README](../README.md)
|
||
|
|
2. **Setting up?** See [Deployment Guide](deployment/deployment.md)
|
||
|
|
3. **Developing?** Check [API Reference](api/reference.md)
|
||
|
|
4. **Operating?** Read [Runbook](operations/runbook.md)
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
When adding new documentation:
|
||
|
|
- Place feature-specific docs in `features/[feature-name]/`
|
||
|
|
- Place deployment-related docs in `deployment/`
|
||
|
|
- Place operational docs in `operations/`
|
||
|
|
- Update this README with links to new documentation
|
||
|
|
|