Skip to content

docs: add AGENTS.md with Cursor Cloud specific instructions #755

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

Closed
avivkeller wants to merge 3 commits into from
Closed

docs: add AGENTS.md with Cursor Cloud specific instructions #755

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4883df9
docs: add AGENTS.md with Cursor Cloud specific instructions
cursoragent Apr 6, 2026
4d8a571
style: format AGENTS.md with Prettier
cursoragent Apr 6, 2026
8246a14
docs: use LTS instead of hardcoded Node 24 in AGENTS.md
cursoragent Apr 6, 2026
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
45 changes: 45 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# AGENTS.md

## Cursor Cloud specific instructions

This is the Node.js API documentation generator (`@node-core/doc-kit`). It is a single-package Node.js CLI tool (no monorepo, no Docker, no external services).

### Runtime

- Requires the **Node.js LTS** version specified in `.nvmrc`. Use `nvm install --lts && nvm use --lts` if not already active.
- Package manager is **npm** (lockfile: `package-lock.json`).

### Key commands

All standard dev commands are in `package.json` `scripts` and documented in `CONTRIBUTING.md`:

| Task | Command |
| ---------------- | -------------------------- |
| Install deps | `npm install` |
| Lint | `node --run lint` |
| Format check | `node --run format` |
| Tests | `node --run test` |
| Tests + coverage | `node --run test:coverage` |
| Run CLI | `node bin/cli.mjs` |

### Running the tool locally

To actually generate docs you need Node.js API markdown sources. Sparse-clone them:

```bash
git clone --depth 1 --sparse https://github.com/nodejs/node.git /tmp/node
cd /tmp/node && git sparse-checkout set --skip-checks doc/api lib CHANGELOG.md
```

Then run against a single file for fast iteration:

```bash
node bin/cli.mjs generate -t legacy-html -i /tmp/node/doc/api/fs.md -o /tmp/out --index /tmp/node/doc/api/index.md -c /tmp/node/CHANGELOG.md
```

### Non-obvious caveats

- The `git sparse-checkout set` command needs `--skip-checks` when including individual files like `CHANGELOG.md` (not directories).
- Pre-commit hook (`npx lint-staged`) runs ESLint + Prettier on staged `.js`/`.mjs`/`.jsx` files. Use `--no-verify` to bypass if needed.
- Tests use Node.js built-in test runner with `--experimental-test-module-mocks` flag (already configured in `package.json` scripts).
- ESLint produces 2 warnings in `src/generators/web/ui/hooks/useOrama.mjs` — these are pre-existing and not errors.
Loading