documentation
Use when editing `docs/**/*.mdx`, generated reference docs, TypeDoc comments, `typedoc.json`, `docs/docs.yml`, or documentation review instructions.
Informations de source
- Dépôt
- alchemyplatform/aa-sdk
- Dernière activité de la source
- 21 mai 2026 à 23:38
- Langue détectée de SKILL.md
- anglais
- Étoiles
- 322
- Forks
- 235
Options d'installation
Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.
Vérifiez les fichiers source
Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.
Explorateur de fichiers
4 fichiersAffichage de SKILL.md
SKILL.md
Instructions source · Aperçu en lecture seule- 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.
Voir sur GitHub