Skip to content

chore: Drop the docs server in favor of opening the files #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobinBol merged 1 commit into from
Oct 23, 2026
Merged

chore: Drop the docs server in favor of opening the files #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,14 @@ This file provides guidance to AI agents when working with code in this reposito

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

The docs are a static site that works straight from disk, no server needed. Off macOS, run
`npm run build` and open `build/index.html` in a browser.

Run single test file:
```bash
npx mocha test/onOff.js
Expand Down
Loading
Loading