Skip to content

Commit 9b6cda1

Browse files
cursoragentboojack
andcommitted
Add AGENTS.md with Cursor Cloud specific instructions
Co-authored-by: boojack <stevenlgtm@gmail.com>
1 parent 6d8de33 commit 9b6cda1

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# AGENTS.md
2+
3+
## Cursor Cloud specific instructions
4+
5+
This is a **Next.js 16 static marketing/docs website** for Memos (usememos.com). No external services, databases, or environment variables are required.
6+
7+
### Services
8+
9+
| Service | Command | Port | Notes |
10+
|---------|---------|------|-------|
11+
| Dev server | `pnpm dev` | 3000 | Uses Turbopack; hot-reloads on file changes |
12+
13+
### Key commands
14+
15+
Refer to `CLAUDE.md` and `package.json` scripts for the full list. Quick reference:
16+
17+
- **Lint**: `pnpm lint` (runs Biome)
18+
- **Format**: `pnpm format` (runs Biome format with `--write`)
19+
- **Build**: `pnpm build` (full production build, generates 300+ static pages)
20+
- **Dev**: `pnpm dev` (starts on port 3000 with Turbopack)
21+
22+
### Gotchas
23+
24+
- The `postinstall` script downloads OpenAPI specs from GitHub (`raw.githubusercontent.com`) and generates MDX + Fumadocs source files. If the network fetch fails during `pnpm install`, the generated API docs will be missing. Rerun `pnpm install` to retry.
25+
- pnpm may warn about ignored build scripts for `esbuild` and `sharp`. This warning is cosmetic and does not block development or builds.
26+
- There are no automated test suites (no `test` script in `package.json`). Verification is done via `pnpm lint` and `pnpm build`.
27+
- The `.source/` directory is auto-generated by `fumadocs-mdx` during `postinstall`. Do not edit files in it directly.

0 commit comments

Comments
 (0)