Skip to content

Commit 187ca5e

Browse files
authored
Merge pull request #246 from athombv/chore/docs-preview-without-serve
chore: Drop the docs server in favor of opening the files
2 parents da91f20 + 96d21d5 commit 187ca5e

3 files changed

Lines changed: 129 additions & 1922 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@ This file provides guidance to AI agents when working with code in this reposito
66

77
```bash
88
npm test # Run all tests (mocha)
9-
npm run lint # ESLint (extends athom config)
10-
npm run build # Generate JSDoc documentation
9+
npm run lint # ESLint (flat config in eslint.config.js)
10+
npm run build # Generate JSDoc documentation into build/
11+
npm run docs # Build the docs and open them in the browser (macOS `open`)
1112
```
1213

14+
The docs are a static site that works straight from disk, no server needed. Off macOS, run
15+
`npm run build` and open `build/index.html` in a browser.
16+
1317
Run single test file:
1418
```bash
1519
npx mocha test/onOff.js

0 commit comments

Comments
 (0)