docs(ai): update quickstart and contributing (agent)

- Updated README.md to suggest sharded unit tests for faster feedback.
- Validated core documentation files against the codebase.
- Created daily task completion log.

Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
google-labs-jules[bot]andPR0M3TH3AN committed 2026-02-14 15:38:49 +00:00
1 parent a07f197773
commit 9d3f8a7051
2 files changed
+45 -3

No files matched your search

+3 -3
View File
@@ -174,13 +174,13 @@ To run **bitvid** locally:
Run tests and linting to ensure everything is working correctly.
```bash
npm run test:unit
npm run test:smoke
npm run test:unit:shard1 # Run a subset of tests for speed
npm run test:smoke # Critical path verification
npm run format
npm run lint
```
_Tip: Use `npm run test:unit:shard1` (or `shard2`/`shard3`) for faster local feedback._
_Tip: Use `npm run test:unit` to run the full suite (can be slow)._
#### Quick Reference
@@ -0,0 +1,42 @@
# Docs Agent Completion Log
- **Date:** 2026-02-14
- **Agent:** docs-agent
- **Cadence:** daily
## Summary
Verified project documentation against the codebase (`package.json`, `js/nostrEventSchemas.js`, `js/services/playbackService.js`, etc.) and confirmed high accuracy. Made minor improvements to `README.md` to highlight faster test commands.
## Actions Taken
1. **Validated `README.md`**:
- Confirmed local setup instructions and script references (`npm ci`, `npm start`, etc.).
- Validated the "Send your first video post" example against `js/nostrClientFacade.js` and `js/nostrEventSchemas.js`.
- Updated the "Verify setup" section to recommend `npm run test:unit:shard1` for faster feedback, aligning with `CONTRIBUTING.md`.
2. **Validated `CONTRIBUTING.md`**:
- Confirmed referenced scripts (`validate-events.mjs`, `setup-pre-commit.sh`, `telemetry-aggregator.mjs`) exist.
- Verified the "Lint" description accurately reflects the absence of ESLint logic checks.
- Confirmed the "Agent PR Conventions" section matches `AGENTS.md`.
3. **Validated `docs/nostr-event-schemas.md`**:
- Verified `NOTE_TYPES` against `js/nostrEventSchemas.js` (including newer types like `GIFT_WRAP`, `DM_READ_RECEIPT`).
- Confirmed the distinction between legacy `USER_BLOCK_LIST` (kind 10000, d="user-blocks") and standard `MUTE_LIST` (kind 10000, no d-tag) is documented.
4. **Validated `docs/playback-fallback.md`**:
- Verified the described fallback flow against `js/services/playbackService.js`.
- Confirmed constants like `WSS_TRACKERS` and `URL_FIRST_ENABLED` match `js/constants.js`.
5. **Linting**:
- Ran `npm run lint` to ensure documentation updates maintained formatting standards.
## Verification Results
- `npm run lint`: **Passed**
- Documentation claims: **Verified** against source code.
- Script existence: **Verified**.
## Follow-up
- None. Documentation is currently in sync with the codebase.