Nautilus/ledgerdock
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: complete repository technical documentation refresh

Browse Source
This commit is contained in:
Beda Schmid
2026-02-21 11:27:44 -03:00
parent 17dccbbe20
commit 6501841426
6 changed files with 454 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/README.md
View File

@@ -1,15 +1,18 @@
# Documentation
This is the documentation entrypoint for DMS.
This directory contains technical documentation for DMS.
## Available Documents
## Core References
- Project setup and operations: `../README.md`
- Frontend visual system and compact UI rules: `frontend-design-foundation.md`
- Handwriting style implementation plan: `../PLAN.md`
- `../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
## Planned Additions
## Documentation Rules
- Architecture overview
- Data model reference
- API contract details
- 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.