Nautilus/tellscoin
1
0
Fork 0
Code Issues Pull Requests Activity

Initial commit

Browse Source
This commit is contained in:
Beda Schmid
2026-02-15 16:28:38 +00:00
commit 0e793197bf
24 changed files with 3268 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/README.md Normal file
View File

@@ -0,0 +1,25 @@
# Documentation Index
This directory contains project documentation for the Bitcoin Core Admin Dashboard.
## Document Map
- `doc/architecture.md` - System architecture, module responsibilities, and runtime flow.
- `doc/api.md` - HTTP API reference, authentication model, and endpoint contracts.
- `doc/data-models.md` - SQLite schema, data invariants, and retention behavior.
- `doc/build-and-deploy.md` - Build, runtime, and deployment rules for local and Docker usage.
- `doc/environment.md` - Environment variables, defaults, and production guidance.
- `doc/conventions.md` - Coding patterns and implementation conventions for this repository.
## Reading Order
1. Start with `doc/architecture.md`.
2. Use `doc/api.md` and `doc/data-models.md` for implementation details.
3. Use `doc/build-and-deploy.md` and `doc/environment.md` for operations.
4. Use `doc/conventions.md` when adding or modifying code.
## Cross-References
- API endpoints depend on persisted settings described in `doc/data-models.md`.
- Runtime behavior and deployment constraints are described in `doc/architecture.md` and `doc/build-and-deploy.md`.
- Configuration contracts in `doc/environment.md` are consumed by modules listed in `doc/architecture.md`.