mirror of
https://github.com/PR0M3TH3AN/TORCH.git
synced 2026-11-03 11:21:53 +00:00
docs: update README.md and TORCH.md with scheduler and lock commands
- Added `scheduler:daily` and `scheduler:weekly` usage examples to README.md and TORCH.md. - Added `lock:complete` and `lock:check:daily` usage examples to README.md and TORCH.md. - Updated TODO list to reflect completion of documentation alignment. - Verified script presence and syntax. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
5783f995d7
commit
439e08042c
16 files changed
+43
-255
No files matched your search
@@ -1,14 +0,0 @@
|
||||
# Docs Alignment Update: Scheduler Scripts
|
||||
|
||||
Context:
|
||||
- `README.md` and `TORCH.md` were missing documentation for key development scripts: `scheduler:daily`, `scheduler:weekly`, and `lock:complete`.
|
||||
|
||||
Observation:
|
||||
- These scripts exist in `package.json` and are critical for testing the scheduler cycle locally.
|
||||
- `lock:complete` is essential for manual lock release during debugging.
|
||||
|
||||
Action Taken:
|
||||
- Added `npm run scheduler:daily`, `npm run scheduler:weekly`, and `npm run lock:complete` to the "NPM Scripts (for development)" sections in both `README.md` and `TORCH.md`.
|
||||
|
||||
Recommendation:
|
||||
- Future agents should check `package.json` scripts when updating documentation to ensure parity.
|
||||
@@ -1,15 +0,0 @@
|
||||
# Memory Update - docs-code-investigator - 20260220T023152Z
|
||||
|
||||
## Summary
|
||||
- Documented `src/services/memory/index.js` with a top-level flow/invariants comment and comprehensive JSDoc across all exports.
|
||||
- Added `docs/memory-index-overview.md` capturing behavior, API contracts, invariants, side effects, call graph, and change guidance.
|
||||
|
||||
## Validation outcomes
|
||||
- `npm run lint` passes.
|
||||
- `npm test` fails on existing environment-sensitive issue in `test/scheduler-preflight-lock.e2e.test.mjs` (platform mismatch: `unknown` vs `codex`).
|
||||
- `test/memory-telemetry.test.mjs` also fails in this environment due empty captured child-process stdout/stderr.
|
||||
- Targeted memory behavior subset passed: `test/memory-admin`, `test/memory-index`, `test/memory-ingest`, `test/memory-run-prune-cycle`, `test/memory-stats`.
|
||||
|
||||
## Reusable notes
|
||||
- For environment-sensitive failures, capture direct non-`--test` runs (`node <testfile>`) to expose hidden assertion details.
|
||||
- Keep documentation-only runs non-invasive: do not patch tests without spec-correction basis.
|
||||
Reference in new issue
Block a user