Slash Command97 repo starsupdated 1mo ago

write-docs

The write-docs command generates comprehensive documentation for Solana blockchain code, including programs, APIs, and components. Use it to create instruction documentation with account tables and error codes, SDK function references with parameters and examples, component property guides, or README files with setup instructions and deployment information. It identifies the documentation type and applies appropriate templates and best practices for clarity and completeness.

View source Repository: solana-ai-kit

Install in Claude Code

Copy

mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/solanabr/solana-ai-kit/HEAD/.claude/commands/write-docs.md -o ~/.claude/commands/write-docs.md

Then start a new Claude Code session; the slash command loads automatically.

Definition

write-docs.md

Generate comprehensive documentation for Solana blockchain code.

## Code to Document

$ARGUMENTS

## Related Context

- **Solana Programs**: See [programs/anchor.md](../skills/ext/solana-dev/skill/references/programs/anchor.md) for IDL patterns
- **Unity/C#**: See [solana-game SKILL.md](../skills/ext/solana-game/skill/SKILL.md) for Unity/C# patterns
- **Detailed Templates**: See **tech-docs-writer** agent for full templates

## Documentation Strategy

### 1. Identify Documentation Type

| Type | What to Generate |
|------|------------------|
| **Program** | Instructions, accounts, PDAs, errors, security, CU |
| **SDK/API** | Functions, params, returns, errors, examples |
| **Component** | Props/properties, events, usage patterns |
| **README** | Overview, setup, quick start, deployment |

### 2. Documentation Requirements

**For Instructions/Endpoints:**
- Accounts table (name, type, description)
- Arguments table (name, type, validation)
- Error codes with descriptions
- Access control notes
- Compute units estimate
- Working code example

**For Account Structures:**
- Purpose and lifecycle
- Size calculation (include discriminator)
- Field table with types and offsets
- PDA seeds (if applicable)
- Rent cost

**For README:**
- Program IDs (mainnet/devnet)
- Installation command
- Quick start example
- Instruction summary table
- Security/audit status

### 3. Best Practices

**Do:**
- Document ALL public functions/instructions
- Include working code examples
- Explain "why", not just "what"
- Include error scenarios
- Update docs when code changes

**Don't:**
- Document obvious code
- Leave non-compiling examples
- Skip security considerations
- Forget to document errors

## Output

Generate documentation appropriate to the code type:

1. **Programs**: Instruction docs, account docs, error codes
2. **SDKs**: Function docs, type definitions, examples
3. **Components**: Props, events, usage patterns
4. **Projects**: README with setup and deployment

For complex projects, delegate to **tech-docs-writer** agent.