From 5663bcea22c3f46b2e90d15a2874afa227e92d92 Mon Sep 17 00:00:00 2001
From: Cursor Agent <cursoragent@cursor.com>
Date: Sat, 30 May 2026 15:58:06 +0000
Subject: [PATCH] docs: add AGENTS.md with Cursor Cloud dev environment notes

Co-authored-by: Arcanum <ArcanePivot@users.noreply.github.com>
---
 AGENTS.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 00000000..ef19cdbc
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,50 @@
+# AGENTS.md
+
+## Cursor Cloud specific instructions
+
+### What this repo is
+
+Single-package **Nuxt 3** documentation site for MemOS (`memos-docs`). There is no backend API or Docker stack in this repo—only the docs app.
+
+### Package manager
+
+Use **pnpm 10.12.1** (see `packageManager` in `package.json`). Enable via Corepack if needed:
+
+```bash
+corepack enable && corepack prepare pnpm@10.12.1 --activate
+```
+
+### Common commands
+
+See `README.md` and `package.json` scripts. Typical workflow:
+
+| Task | Command |
+|------|---------|
+| Install | `pnpm install` |
+| Dev server | `NUXT_ENV_CONFIG=dev pnpm dev` → http://localhost:3000 |
+| Lint | `pnpm exec nuxt prepare` then `pnpm run lint` |
+| Typecheck | `pnpm run typecheck` |
+| Static build | `NUXT_ENV_CONFIG=dev pnpm run generate` (or `pnpm run publish`) |
+| Preview build | `pnpm preview` |
+
+`NUXT_ENV_CONFIG` selects `envConfig/config.{dev,pre,prod}.ts`. Use **`dev`** locally so `envConfig/config.dev.ts` points domains at `http://localhost:3000`.
+
+### Dev server notes
+
+- First `pnpm dev` parses all markdown under `content/` (can take ~10–20s before the server is ready).
+- **Nuxt Content** uses in-process **SQLite** via `better-sqlite3` (native module; listed in `pnpm.onlyBuiltDependencies`).
+- Optional floating **AI assistant** calls `https://apigw.memtensor.cn` (`runtimeConfig.public.apiBase`); docs browsing and search work without it.
+
+### Lint / typecheck caveats
+
+- ESLint imports `.nuxt/eslint.config.mjs`; run **`nuxt prepare`** once after install (or before lint) so `.nuxt` exists.
+- `pnpm run lint` and `pnpm run typecheck` may report **pre-existing** issues in the repo; they do not block `pnpm dev` or `pnpm run generate`.
+
+### Maintenance scripts (not required for dev)
+
+- `pnpm run sync-api` / `sync-releases` — need network; releases may use `GITHUB_TOKEN`.
+- CI auto-translate uses `OPENAI_*` env vars (see `.github/workflows/auto-translate.yml`).
+
+### i18n
+
+English is default; Chinese content lives under `content/cn/`. Routing uses `@nuxtjs/i18n` with `prefix_except_default`—check `nuxt.config.ts` for locale paths if `/cn` behavior differs between SSR and client navigation.