17 lines
1.1 KiB
Markdown
17 lines
1.1 KiB
Markdown
# DMARC Watch Developer Docs
|
|
|
|
This folder documents the implemented repository for developers and LLM agents. It is a code-navigation aid, not end-user product documentation.
|
|
|
|
## Index
|
|
|
|
- [Repository structure](repository.md): top-level files, application package layout, tests, design references, and generated runtime paths.
|
|
- [Runtime and development workflow](runtime.md): configuration loading, local test commands, Docker entry points, scheduler jobs, and CLI/API processing paths.
|
|
- [Code map](code-map.md): major modules, data flow, persistence models, alerting, LLM usage, and dashboard/API surfaces.
|
|
- [Agent notes](agent-notes.md): scoped guidance for future code changes and documentation work in this repository.
|
|
|
|
## Scope Notes
|
|
|
|
- The repository is named DMARC Watch in the orchestration context, while the implemented FastAPI application currently identifies itself as `DMARC Sentinel`.
|
|
- Settings are loaded from host-controlled files and environment variables. The implemented settings page is read-only.
|
|
- These docs describe current files only. They do not define migration, compatibility, or product roadmap decisions.
|