documentation
Use when editing `docs/**/*.mdx`, generated reference docs, TypeDoc comments, `typedoc.json`, `docs/docs.yml`, or documentation review instructions.
Source facts
- Repository
- alchemyplatform/aa-sdk
- Last source activity
- May 21, 2026 at 23:38
- Detected SKILL.md language
- English
- Stars
- 322
- Forks
- 235
Install options
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Review the source files
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
File Explorer
4 filesShowing SKILL.md
SKILL.md
Source instructions · Read-only preview- 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
# Documentation
aa-sdk documentation is MDX under `docs/`, with committed TypeDoc reference
output under `docs/pages/reference/` and navigation in `docs/docs.yml`.
## Rules
| Rule | When to read |
| --------------------------------------------------------------------- | ------------------------------------------------------------ |
| [MDX code preservation](rules/mdx-code-preservation.md) | Before editing docs code snippets. |
| [TypeDoc reference generation](rules/typedoc-reference-generation.md) | Before changing reference docs or TSDoc. |
| [docs.yml navigation](rules/docs-yml-navigation.md) | Before changing docs navigation or reference nav generation. |
## Evidence
- `typedoc.json` writes `.mdx` output to `docs/pages/reference`.
- `scripts/generate-typedoc-yaml.ts` scans reference MDX and updates
`docs/docs.yml`.
- Existing `.claude`, `.cursor`, and `.github` docs instructions emphasize code
snippet preservation.
View on GitHub