Skip to content

Commit 12da4ba

Browse files
committed
chore: add Cursor Cloud specific instructions to AGENTS.md
Added development environment guidance for cloud agents including: - Environment setup notes (.env, pnpm install warnings) - Dev server startup details - Linting/testing command clarifications - Git hook documentation
1 parent d311dc4 commit 12da4ba

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CLAUDE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,3 +209,25 @@ module example::hello {
209209
- [Starlight Documentation](https://starlight.astro.build/)
210210
- [MDX Documentation](https://mdxjs.com/)
211211
- [Aptos Developer Portal](https://aptos.dev)
212+
213+
## Cursor Cloud specific instructions
214+
215+
This is a single-service Astro/Starlight documentation site. No databases, Docker, or external services are required for local development.
216+
217+
### Environment setup
218+
219+
- Ensure `.env` exists (copy from `.env.example` if missing). Default values are sufficient for local dev; optional services (Firebase, Algolia, OG images) degrade gracefully when their env vars are empty.
220+
- Run `pnpm install` to install dependencies. pnpm may warn about ignored build scripts for native packages (`@swc/core`, `esbuild`, `sharp`, etc.) — these warnings are safe to ignore as the packages ship pre-built binaries.
221+
222+
### Running the dev server
223+
224+
- `pnpm dev` starts the Astro dev server at `http://localhost:4321`.
225+
- The `predev` script automatically builds middleware matcher and starts middleware watcher in the background.
226+
- Search (Algolia DocSearch) is disabled in dev mode; this is expected.
227+
228+
### Linting and testing
229+
230+
- `pnpm lint` runs Biome and Prettier in parallel (not ESLint, despite what some comments say).
231+
- `pnpm test` runs Vitest tests.
232+
- `pnpm check` runs Astro type checking.
233+
- Git hooks: `pre-commit` runs `nano-staged` (Biome + Prettier on staged files), `pre-push` runs `astro check --noSync`.

0 commit comments

Comments
 (0)