Skip to content

Commit 35a12b3

Browse files
committed
docs: move specs and task board under docs/
1 parent a6536d0 commit 35a12b3

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Build and maintain `mem.net` as a robust, configurable memory service that is ea
3434
- Keep tests deterministic and environment-independent.
3535

3636
## Documentation Rules
37-
- Update `TASK_BOARD.md` when status changes.
37+
- Update `docs/project/TASK_BOARD.md` when status changes.
3838
- Preserve historical status in `docs/archive/TASK_BOARD_ARCHIVE.md` when simplifying active board content.
3939
- Keep `README.md` run instructions accurate.
40-
- Keep implementation aligned with `MEMORY_SERVICE_SPEC.md`; document intentional deviations.
40+
- Keep implementation aligned with `docs/specs/MEMORY_SERVICE_SPEC.md`; document intentional deviations.
4141

4242
## Azure SDK Rule
4343
- For any specific Azure SDK/API usage (types, methods, options, auth flows), verify against the latest Microsoft docs before coding.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,9 @@ dotnet run --project tools/MemNet.Bootstrap -- azure --apply
262262

263263
## Repository Guide
264264

265-
- `MEMORY_SERVICE_SPEC.md`: service technical spec (normative contract)
266-
- `SDK_SPEC.md`: SDK technical spec (`MemNet.Client`, `MemNet.AgentMemory`)
267-
- `TASK_BOARD.md`: active execution board
265+
- `docs/specs/MEMORY_SERVICE_SPEC.md`: service technical spec (normative contract)
266+
- `docs/specs/SDK_SPEC.md`: SDK technical spec (`MemNet.Client`, `MemNet.AgentMemory`)
267+
- `docs/project/TASK_BOARD.md`: active execution board
268268
- `docs/archive/TASK_BOARD_ARCHIVE.md`: historical phase log
269269
- `src/MemNet.MemoryService`: service runtime
270270
- `src/MemNet.Client`: low-level .NET SDK
@@ -275,6 +275,6 @@ dotnet run --project tools/MemNet.Bootstrap -- azure --apply
275275

276276
For non-trivial changes:
277277

278-
1. Align behavior with `MEMORY_SERVICE_SPEC.md`.
278+
1. Align behavior with `docs/specs/MEMORY_SERVICE_SPEC.md`.
279279
2. Add or update tests.
280-
3. Update docs and `TASK_BOARD.md`.
280+
3. Update docs and `docs/project/TASK_BOARD.md`.

docs/archive/TASK_BOARD_ARCHIVE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Phase 0 - Project Setup
99
- [x] Initialize solution and projects
10-
- [x] Add repo docs (`README.md`, `AGENTS.md`, `TASK_BOARD.md`)
10+
- [x] Add repo docs (`README.md`, `AGENTS.md`, `docs/project/TASK_BOARD.md`)
1111
- [x] Configure offline-friendly NuGet behavior
1212

1313
## Phase 1 - Core Domain and Config
@@ -81,7 +81,7 @@
8181
- [x] Add retries/timeouts for Azure SDK calls with bounded policies
8282
- [x] Add structured logs with tenant/user/path correlation fields
8383
- [x] Document Azure setup in `README.md` (auth, env vars, index bootstrap)
84-
- [x] Final review vs `MEMORY_SERVICE_SPEC.md` and close remaining gaps
84+
- [x] Final review vs `docs/specs/MEMORY_SERVICE_SPEC.md` and close remaining gaps
8585

8686
## Phase 11 - First-Principles Simplification
8787
- [x] Collapse runtime config to a single policy model (`policy.json`) (later removed in Phase 16.5)
@@ -108,8 +108,8 @@
108108
- [x] Update README/spec docs with bootstrap flow and deployment order
109109

110110
## Phase 14 - v2 Boundary Lock (Service/SDK)
111-
- [x] Redefine `MEMORY_SERVICE_SPEC.md` to policy-free v2 target boundary
112-
- [x] Redefine `SDK_SPEC.md` so policy/binding/slot validation is SDK-owned
111+
- [x] Redefine `docs/specs/MEMORY_SERVICE_SPEC.md` to policy-free v2 target boundary
112+
- [x] Redefine `docs/specs/SDK_SPEC.md` so policy/binding/slot validation is SDK-owned
113113
- [x] Define pre-release breaking-change policy (no compatibility commitments)
114114

115115
## Phase 15 - Service v2 Migration
@@ -141,7 +141,7 @@
141141
- [x] Define official LLM memory tool contract (`memory_recall`, `memory_load_file`, `memory_patch_file`, `memory_write_file`)
142142
- [x] Define deterministic text patch request shape (`old_text`, `new_text`, `occurrence`) and error model
143143
- [x] Decide native route shape (`/documents` with file payload vs dedicated `/files` routes) and document in specs
144-
- [x] Update `MEMORY_SERVICE_SPEC.md` and `SDK_SPEC.md` with authoritative file-first contracts and pre-release boundary
144+
- [x] Update `docs/specs/MEMORY_SERVICE_SPEC.md` and `docs/specs/SDK_SPEC.md` with authoritative file-first contracts and pre-release boundary
145145

146146
### 17B - API Simplification First (Service)
147147
- [x] Replace `/documents/{namespace}/{path}` with `/files/{**path}` as canonical file API
@@ -202,7 +202,7 @@
202202
### 18F - Cleanup and Exit
203203
- [x] Create and complete old-to-new test parity checklist
204204
- [x] Remove or slim custom executable spec runner to smoke-only scope
205-
- [x] Update `README.md`, `TASK_BOARD.md`, and specs with final test strategy
205+
- [x] Update `README.md`, `docs/project/TASK_BOARD.md`, and specs with final test strategy
206206
- [ ] Close Phase 18 only after CI passes with framework tests and coverage reporting
207207

208208
## Residual Gaps (Post-Review)

TASK_BOARD.md renamed to docs/project/TASK_BOARD.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
### Docs and Contract Clarity
2929

3030
- [x] Rewrite `README.md` to file-first model with migration guide
31-
- [x] Rewrite `MEMORY_SERVICE_SPEC.md` as normative policy-free contract
32-
- [x] Rewrite `SDK_SPEC.md` with file-like tools as primary SDK surface
31+
- [x] Rewrite `docs/specs/MEMORY_SERVICE_SPEC.md` as normative policy-free contract
32+
- [x] Rewrite `docs/specs/SDK_SPEC.md` with file-like tools as primary SDK surface
3333
- [x] Split task tracking into active board + archive log
3434

3535
### File-First v2 Boundary
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)