Skip to content

Commit 6b114d0

Browse files
committed
docs: document layer rules
1 parent b06606c commit 6b114d0

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@
1616

1717
All-in-one proxy written in Rust.
1818

19+
## Layer Rules
20+
21+
This repo follows a simple Clean/Hex-ish layering:
22+
23+
- **Domain**: `rd-interface`, `rd-derive` (traits/types/derive only; no concrete implementations)
24+
- **Core**: `rabbit-digger` (runtime/orchestration; depends only on Domain)
25+
- **Adapters**: `rd-std`, `protocol/*` (concrete nets/servers; depend on Domain)
26+
- **App**: `rabbit-digger-pro` (CLI/API/config; composes everything via a bundle)
27+
28+
Dependency direction is enforced in CI via `depguard`.
29+
1930
## Features
2031

2132
* Hot reloading: Apply changes without restart the program.

agent-docs/ARCH_REFACTOR_PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ This document turns the proposed Clean/Hex refactor into a commit-friendly check
6060
## 4) Guardrails (recommended)
6161

6262
- [x] Add CI checks for dependency direction (e.g. `cargo tree -i` patterns or `cargo deny`).
63-
- [ ] Add a short “layer rules” section to README.
63+
- [x] Add a short “layer rules” section to README.
6464
- [ ] Prefer `pub(crate)` for app-internal modules; keep Domain/Core public APIs minimal.
6565

6666
## 5) Execution Order (what I will do next)

0 commit comments

Comments
 (0)