Skip to content

docs: List the format and type commands, drop a stale npmignore note #251

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

docs: List the format and type commands, drop a stale npmignore note #251

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
2 changes: 0 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ name: Deploy Documentation To GitHub Pages

# Note: make sure to commit package-lock.json, this is needed for `npm ci`.

# Note: add `.github` to .npmignore

on:
push:
branches: [production]
Expand Down
11 changes: 7 additions & 4 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@ This file provides guidance to AI agents when working with code in this reposito
## Commands

```bash
npm test # Run all tests (node:test)
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`)
npm test # Run all tests (node:test)
npm run lint # ESLint (flat config in eslint.config.js)
npm run format:check # Prettier check, run in CI next to lint
npm run format:write # Apply Prettier; run before committing
npm run generate-types # Regenerate index.d.ts from the cluster definitions
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
Expand Down
Loading