mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-10-27 07:52:24 +00:00
docs: align development docs with codebase behavior
Updated CLAUDE.md to include missing scripts (audit, test:load, telemetry:aggregate) that were present in package.json but undocumented. Created completion log. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
3e2f670b16
commit
7117b2bfe6
2 files changed
+34
No files matched your search
@@ -135,6 +135,8 @@ npm run test:visual
|
||||
| `npm run lint:tokens` | Design token enforcement |
|
||||
| `npm run lint:file-size` | Enforce file size limits |
|
||||
| `npm run lint:innerhtml` | Enforce innerHTML baseline |
|
||||
| `npm run audit` | Run design system audit |
|
||||
| `npm run build:beacon` | Build torrent beacon assets |
|
||||
| `npm run test:unit` | Full unit test suite |
|
||||
| `npm run test:unit:shard1` | Shard 1/3 (faster local dev) |
|
||||
| `npm run test:unit:shard2` | Shard 2/3 |
|
||||
@@ -143,7 +145,10 @@ npm run test:visual
|
||||
| `npm run test:dm:unit` | Direct message unit tests |
|
||||
| `npm run test:dm:integration` | DM integration tests |
|
||||
| `npm run test:e2e` | Headless E2E tests |
|
||||
| `npm run test:load` | Run load tests |
|
||||
| `npm run test:visual` | Visual regression tests |
|
||||
| `npm run test:visual:update` | Update visual regression baselines |
|
||||
| `npm run telemetry:aggregate` | Aggregate telemetry logs |
|
||||
| `node scripts/agent/validate-events.mjs` | Validate Nostr event schemas |
|
||||
|
||||
---
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
# Daily Task: Docs Alignment Agent
|
||||
|
||||
**Date:** 2026-02-20
|
||||
**Agent:** docs-alignment-agent
|
||||
**Status:** Completed
|
||||
|
||||
## Summary of Changes
|
||||
Updated `CLAUDE.md` to include missing development scripts that were present in `package.json` but undocumented in the "Available Scripts" table. This ensures agents have a complete reference for available tools.
|
||||
|
||||
## Claims Map (Audit)
|
||||
|
||||
| Script | Documented in CLAUDE.md | Status | Action |
|
||||
|--------|-------------------------|--------|--------|
|
||||
| `npm run build` | Yes | ✅ Match | None |
|
||||
| `npm run build:css` | Yes | ✅ Match | None |
|
||||
| `npm run audit` | No | ⚠️ Missing | Added |
|
||||
| `npm run build:beacon` | No | ⚠️ Missing | Added |
|
||||
| `npm run test:load` | No | ⚠️ Missing | Added |
|
||||
| `npm run test:visual:update` | No | ⚠️ Missing | Added |
|
||||
| `npm run telemetry:aggregate` | No | ⚠️ Missing | Added |
|
||||
| `npm run validate:torch-extraction` | No | ⚠️ Missing | Skipped (Internal tool) |
|
||||
|
||||
## Diagnosis
|
||||
Several useful maintenance and testing scripts (`audit`, `test:load`, `telemetry:aggregate`) were missing from the primary agent guide (`CLAUDE.md`). These scripts are critical for tasks involving design system audits, performance testing, and telemetry.
|
||||
|
||||
## Validation Notes
|
||||
- Ran `npm run lint`: Passed.
|
||||
- Ran `npm run audit`: Passed (generated `REMEDIATION_REPORT.md`).
|
||||
- Ran `npm run telemetry:aggregate`: Passed (graceful exit).
|
||||
Reference in new issue
Block a user