Skip to content

docs: Document Cloud Agent setup for the docs site #12

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

Draft
AriKaufs wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Document Cloud Agent setup for the docs site #12

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
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- END:nextjs-agent-rules -->

## 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.
Loading