// Use when editing `docs/**/*.mdx`, generated reference docs, TypeDoc comments, `typedoc.json`, `docs/docs.yml`, or documentation review instructions.
Use when changing GitHub workflows, Lerna versioning, package publish, or post-merge docs hooks (revalidate + SDK indexer).
Use when writing or modifying Vitest tests, `.vitest` setup, Anvil/Foundry or Rundler fixtures, per-package test config, or CI affected-test behavior.
Use when changing package management, workspace config, build scripts, generated outputs, Turborepo/Lerna config, or local validation in aa-sdk.
Use when throwing, catching, wrapping, documenting, or testing runtime errors in aa-sdk packages.
Use when changing package entry points, `exports` maps, public API barrels, import paths, or subpath exports in aa-sdk packages.
Use when changing `packages/smart-accounts`, account implementations, modules, permissions, nonces, deferred actions, or account address helpers.
| name | documentation |
| description | Use when editing `docs/**/*.mdx`, generated reference docs, TypeDoc comments, `typedoc.json`, `docs/docs.yml`, or documentation review instructions. |
| last_verified | "2026-05-06T00:00:00.000Z" |
aa-sdk documentation is MDX under docs/, with committed TypeDoc reference
output under docs/pages/reference/ and navigation in docs/docs.yml.
| Rule | When to read |
|---|---|
| MDX code preservation | Before editing docs code snippets. |
| TypeDoc reference generation | Before changing reference docs or TSDoc. |
| docs.yml navigation | Before changing docs navigation or reference nav generation. |
typedoc.json writes .mdx output to docs/pages/reference.scripts/generate-typedoc-yaml.ts scans reference MDX and updates
docs/docs.yml..claude, .cursor, and .github docs instructions emphasize code
snippet preservation.