From 7764b1ff481fee5508bf0f07615233c91387bcc3 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Thu, 1 Oct 2026 02:03:51 +0000 Subject: [PATCH] docs: Document Cloud Agent setup for the docs site Record Node 24, the local dev server, and the CI checks so later agents can run the docs app without guessing the toolchain. Co-authored-by: Ari --- AGENTS.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 643577d..4d8f2f5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,3 +7,19 @@ This version has breaking changes — APIs, conventions, and file structure may This block is written and re-added by `next dev` — verify at `node_modules/next/dist/server/lib/generate-agent-files.js`. Removing it from a diff only re-creates the uncommitted change; committing it with your work keeps the tree clean. + +## Cursor Cloud specific instructions + +This site runs with Node.js 24, matching `.github/workflows/docs.yml` and the Dockerfile. The Cloud Agent image can put an older `node` earlier on `PATH` (`/exec-daemon/node`). Select Node 24 with nvm before install, dev, or CI checks: + +```bash +export NVM_DIR="$HOME/.nvm" +. "$NVM_DIR/nvm.sh" +nvm use 24 +export PATH="$(dirname "$(nvm which 24)"):$PATH" +``` + +- Install with `npm ci`. No database, API key, or external search account is required. Search is local Fumadocs/Orama. +- Dev server: `npm run dev -- --hostname 0.0.0.0 --port 3000`. Docs are `/`, Academy is `/academy`, and the API reference is `/api-reference/introduction`. +- CI checks: `npm run check`, `npm run build`, then `npm run verify`. `verify` starts the standalone server and checks content routes, navigation, local links, search, and the 404 response. +- `npm run docs:check` compares tool guides with the sibling Innflow checkout (`../innflow` or `INNFLOW_SOURCE`) and needs that repo's dependencies, including `tsx`. It is not required to build or serve this site.