Agent skill

Documentation

by alchemyplatform in alchemyplatform/aa-sdk

A skill your agent uses when editing docs//.mdx, generated reference docs, TypeDoc comments, typedoc.json, docs/docs.yml, or documentation review instructions.

MITAuto-check passedDocuments & Office

Install Documentation

skills CLI
$ npx skills add alchemyplatform/aa-sdk --skill documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install alchemyplatform/aa-sdk documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/alchemyplatform/aa-sdk.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation .claude/skills/documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation
GitHub stars
321
Token cost
~339 tokens
SKILL.md length
75 words
Files
4
Skills in repo
8
Repo updated
First seen
Licence
MIT

At a glance

A skill your agent uses when editing docs//.mdx, generated reference docs, TypeDoc comments, typedoc.json, docs/docs.yml, or documentation review instructions.

  • Editing docs//.mdx
  • SKILL.md covers Rules and Evidence
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Generated reference docs

What it does

Documentation is an agent skill from alchemyplatform/aa-sdk. Use when editing docs//.mdx, generated reference docs, TypeDoc comments, typedoc.json, docs/docs.yml, or documentation review instructions.

Its SKILL.md is about 340 tokens, which your agent loads only when the skill is triggered. The skill folder holds 4 other files (for example `rules/docs-yml-navigation.md`, `rules/mdx-code-preservation.md` and `rules/typedoc-reference-generation.md`).

It sits in Documents & Office, covering Markdown. The licence is MIT.

When your agent uses it

  • Editing docs//.mdx
  • Generated reference docs
  • TypeDoc comments
  • Documentation review instructions

Example prompts

  • “/documentation”

What it can do on your machine

Read from SKILL.md and the folder at commit 2d60342. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation loads about 339 tokens when it runs. Until then it costs about 41 tokens; SKILL.md has 75 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~41
When it runs · the whole SKILL.md, loaded when a task matches
~339

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from alchemyplatform/aa-sdk at commit 2d60342, republished under its MIT licence (© alchemyplatform). 75 words, ~339 tokens.

Download SKILL.mdSave it as .claude/skills/documentation/SKILL.md (or your agent's skills folder). This skill also uses 3 other files; get the full folder from GitHub.
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-06

Documentation

aa-sdk documentation is MDX under docs/, with committed TypeDoc reference output under docs/pages/reference/ and navigation in docs/docs.yml.

Rules

RuleWhen to read
MDX code preservationBefore editing docs code snippets.
TypeDoc reference generationBefore changing reference docs or TSDoc.
docs.yml navigationBefore 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, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 3 other files in .agents/skills/documentation of alchemyplatform/aa-sdk.

  • SKILL.md
  • rules/docs-yml-navigation.md
  • rules/mdx-code-preservation.md
  • rules/typedoc-reference-generation.md

Open the folder on GitHubat commit 2d60342

Compare with similar skills

Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation this skillalchemyplatform/aa-sdk321—~339Automated safety check: PassMIT
Markdown Article FormatterJimLiu/baoyu-skills26k6 repos~3.5kAutomated safety check: PassMIT
MarkitdownImCa0/just-laws78114 repos~3.2kAutomated safety check: NotesMIT
Obsidian MarkdownAtmosphere/atmosphere3.8k20 repos~1.3kAutomated safety check: PassApache-2.0
Gzh Designisjiamu/gzh-design-skill3.9k1 repos~2.2kAutomated safety check: PassAGPL-3.0
Crosspostingwasp-lang/wasp19k—~1.1kAutomated safety check: PassMIT

Similar skills

  • Markdown Article Formatter

    JimLiu/baoyu-skills

    Reformats plain text or Markdown articles with frontmatter, a title, a summary, headings, bold, lists and code blocks, and saves a separate formatted copy.

    26k GitHub starsUsed in 6 repos~3.5k tokens
    Documents & OfficeAuto-check passed
  • Markitdown

    ImCa0/just-laws

    Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.

    781 GitHub starsUsed in 14 repos~3.2k tokens
    Documents & OfficeAuto-check: notes
  • Obsidian Markdown

    Atmosphere/atmosphere

    Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.

    3.8k GitHub starsUsed in 20 repos~1.3k tokens
    Documents & OfficeAuto-check passed
  • Gzh Design

    isjiamu/gzh-design-skill

    微信公众号文章排版引擎,将 Markdown 转换为可直接粘贴到公众号编辑器的 HTML。主题风格从 references/theme-index.md 注册的自定义主题库中选取,自动章节编号、关键词下划线标记、引言卡片、目录导航、代码块、图片/GIF、作者签名。支持 Markdown / Word(.docx) / PDF / 纯文本输入(非 Markdown…

    3.9k GitHub starsUsed in 1 repo~2.2k tokens
    Documents & OfficeAuto-check passed
  • Crossposting

    wasp-lang/wasp

    Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.

    19k GitHub stars~1.1k tokensUpdated today
    Documents & OfficeAuto-check passed
  • Segment Docs

    JanDeDobbeleer/oh-my-posh

    Reference mapping between Oh My Posh Go segment source code and MDX documentation.

    24k GitHub stars~1.1k tokensUpdated today
    Documents & OfficeAuto-check passed

More from alchemyplatform/aa-sdk

All 8 skills in this repo
  • Error Handling

    alchemyplatform/aa-sdk

    A skill your agent uses when throwing, catching, wrapping, documenting, or testing runtime errors in aa-sdk packages.

    321 GitHub stars~299 tokensUpdated 2 days ago
    Auto-check passed
  • Package Exports

    alchemyplatform/aa-sdk

    A skill your agent uses when changing package entry points, exports maps, public API barrels, import paths, or subpath exports in aa-sdk packages.

    321 GitHub stars~364 tokensUpdated 2 days ago
    Auto-check passed
  • Release Workflows

    alchemyplatform/aa-sdk

    A skill your agent uses when changing GitHub workflows, Lerna versioning, package publish, or post-merge docs hooks (revalidate + SDK indexer).

    321 GitHub stars~417 tokensUpdated 2 days ago
    Auto-check passed
  • Smart Accounts

    alchemyplatform/aa-sdk

    A skill your agent uses when changing packages/smart-accounts, account implementations, modules, permissions, nonces, deferred actions, or account address helpers.

    321 GitHub stars~346 tokensUpdated 2 days ago
    Auto-check passed
  • Testing

    alchemyplatform/aa-sdk

    A skill your agent uses when writing or modifying Vitest tests, .vitest setup, Anvil/Foundry or Rundler fixtures, per-package test config, or CI affected-test behavior.

    321 GitHub stars~305 tokensUpdated 2 days ago
    Auto-check passed
  • Tooling

    alchemyplatform/aa-sdk

    A skill your agent uses when changing package management, workspace config, build scripts, generated outputs, Turborepo/Lerna config, or local validation in aa-sdk.

    321 GitHub stars~374 tokensUpdated 2 days ago
    Auto-check passed

Questions about Documentation

What does Documentation do?

A skill your agent uses when editing docs//.mdx, generated reference docs, TypeDoc comments, typedoc.json, docs/docs.yml, or documentation review instructions. Documentation is an agent skill from alchemyplatform/aa-sdk.yml, or documentation review instructions.

When should I use Documentation?

Documentation fits situations like: editing docs//.mdx; generated reference docs; typeDoc comments; documentation review instructions.

How do I install Documentation in Claude Code?

Run `npx skills add alchemyplatform/aa-sdk --skill documentation -a claude-code`. Or copy the skill folder (.agents/skills/documentation in alchemyplatform/aa-sdk) into .claude/skills/documentation in your project. Claude Code loads it when a task matches its description.

How do I install Documentation in Codex?

Run `npx skills add alchemyplatform/aa-sdk --skill documentation -a codex`. Or copy the skill folder (.agents/skills/documentation in alchemyplatform/aa-sdk) into .agents/skills/documentation in your project. Codex loads it when a task matches its description.

Can I use Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add alchemyplatform/aa-sdk --skill documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation, .gemini/skills/documentation, .github/skills/documentation and .opencode/skills/documentation in your project.

What does Documentation need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation is instructions for the agent only.

Does Documentation access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation use?

Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation use?

About 339 tokens (SKILL.md is roughly 1.4k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Documentation?

Skills that share tags, products or a category with Documentation: Markdown Article Formatter (JimLiu/baoyu-skills, 26k stars), Markitdown (ImCa0/just-laws, 781 stars), Obsidian Markdown (Atmosphere/atmosphere, 3.8k stars) and Gzh Design (isjiamu/gzh-design-skill, 3.9k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation?

alchemyplatform (a GitHub organization) maintains it in alchemyplatform/aa-sdk, which has 321 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 5, 2026.

Source: alchemyplatform/aa-sdk on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.