Skip to content

Commit 2e73bc3

Browse files
committed
Add AGENTS.md with Cursor Cloud development instructions
1 parent 3036b2d commit 2e73bc3

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
### Project Overview
6+
7+
This is the **Node.js official website** (nodejs.org), a pnpm monorepo with Turborepo. Single product in `apps/site` (Next.js), plus shared packages in `packages/`.
8+
9+
### Prerequisites
10+
11+
- **Node.js v24** (see `.nvmrc`)
12+
- **pnpm 10.33.0** (see `packageManager` in root `package.json`)
13+
14+
### Key Commands
15+
16+
All standard commands are documented in `docs/getting-started.md`. Quick reference:
17+
18+
| Task | Command |
19+
| ------------ | ------------------------------------------ |
20+
| Install deps | `pnpm install --frozen-lockfile` |
21+
| Dev server | `pnpm dev` (runs at http://localhost:3000) |
22+
| Lint | `pnpm lint` |
23+
| Format + fix | `pnpm format` |
24+
| Unit tests | `pnpm test` |
25+
| Build | `pnpm build` |
26+
27+
### Non-obvious Caveats
28+
29+
- The root `/` route returns a 307 redirect to `/en`. Always test against `http://localhost:3000/en` for a 200 response.
30+
- The dev server compiles pages on-demand (Turbopack). The first page load after `pnpm dev` takes ~15 seconds; subsequent loads are fast.
31+
- No databases, Docker, or external services are required for local development. Search uses Orama Cloud with hardcoded public dev keys.
32+
- The pre-commit hook runs `node --run lint:staged` and `node --run lint:types`. Ensure these pass before committing.
33+
- `pnpm test` maps to `turbo test:unit` which runs the Node.js built-in test runner (not Jest/Vitest). Tests use `node:test` and `node:assert`.
34+
- When using nvm, after switching to Node.js v24 you need to ensure pnpm is available (via `corepack enable && corepack prepare pnpm@10.33.0 --activate`).

0 commit comments

Comments
 (0)