19 lines
881 B
Markdown
19 lines
881 B
Markdown
# Documentation
|
|
|
|
This directory contains technical documentation for DMS.
|
|
|
|
## Core References
|
|
|
|
- `../README.md` - project overview, setup, and quick operations
|
|
- `architecture-overview.md` - backend, frontend, and infrastructure architecture
|
|
- `api-contract.md` - API endpoint contract grouped by route module
|
|
- `data-model-reference.md` - database entity definitions and lifecycle states
|
|
- `operations-and-configuration.md` - runtime operations, ports, volumes, and configuration values
|
|
- `frontend-design-foundation.md` - frontend visual system, tokens, and UI implementation rules
|
|
|
|
## Documentation Rules
|
|
|
|
- Keep this file as the documentation index and add new technical documents here.
|
|
- Update referenced documents whenever behavior, routes, models, or runtime configuration change.
|
|
- Prefer concise, implementation-backed descriptions with explicit paths to source modules.
|