diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65960f18..c838bbcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,7 +99,7 @@ To set up the project locally: - **NPM**: v10 or higher (included with Node 22). 2. **Install Dependencies**: - Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`. If you intend to run smoke or visual tests, also install Playwright browsers. + Use `npm ci` to ensure you get the exact dependencies from `package-lock.json`. If you intend to run smoke, visual, or end-to-end tests, also install Playwright browsers. ```bash npm ci @@ -142,7 +142,7 @@ To set up the project locally: ```bash npm run test:e2e - npm run test:smoke + npm run test:smoke # Critical path verification npm run test:visual ``` @@ -165,12 +165,6 @@ To set up the project locally: npm run test:dm:integration ``` - To run smoke tests (critical path verification): - - ```bash - npm run test:smoke - ``` - To aggregate telemetry from test logs: ```bash diff --git a/README.md b/README.md index fd6f2a15..b834a2bf 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ To run **bitvid** locally: 2. Install dependencies: - Use `npm ci` to install dependencies exactly as specified in `package-lock.json`. If you intend to run smoke or visual tests, also install Playwright browsers. + Use `npm ci` to install dependencies exactly as specified in `package-lock.json`. If you intend to run smoke, visual, or end-to-end tests, also install Playwright browsers. ```bash npm ci @@ -215,7 +215,6 @@ For detailed architecture and system documentation, see the [Documentation Index - **Run headless E2E tests**: `npm run test:e2e` - **Run visual regression tests**: `npm run test:visual` - **Update visual baselines**: `npm run test:visual:update` -- **Run smoke tests**: `npm run test:smoke` (Critical path verification) - **Run design system audit**: `npm run audit` (Generates remediation report) - **Aggregate telemetry**: `npm run telemetry:aggregate` - **Cancel CI runs**: See [`docs/cancelling-ci-runs.md`](docs/cancelling-ci-runs.md) for a script to clear pending workflows. diff --git a/docs/agents/task-logs/daily/2026-02-16_13-05-00_docs-agent_completed.md b/docs/agents/task-logs/daily/2026-02-16_13-05-00_docs-agent_completed.md new file mode 100644 index 00000000..15dc10bf --- /dev/null +++ b/docs/agents/task-logs/daily/2026-02-16_13-05-00_docs-agent_completed.md @@ -0,0 +1,13 @@ +# docs-agent Task Log + +- **Date**: 2026-02-16 +- **Agent**: docs-agent +- **Status**: Completed +- **Cadence**: Daily + +## Activities +- Audited `README.md` and `CONTRIBUTING.md` for duplicate instructions. +- Removed redundant `npx playwright install` commands. +- Consolidated installation instructions. +- Removed redundant `npm run test:smoke` entries and clarified existing ones. +- Verified changes with `npm run lint` and `npm run format`.