Documentation

Use when editing `docs/**/*.mdx`, generated reference docs, TypeDoc comments, `typedoc.json`, `docs/docs.yml`, or documentation review instructions.

alchemyplatform b7492c3 4 files · 3.9 KB Updated

File contents

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 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.

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.

alchemyplatform/aa-sdk/tree/main/.agents/skills/documentation commit b7492c392b

Frequently asked questions

npx skillmds@latest add alchemyplatform/documentation