---

name: docs description: Write and improve documentation including code comments, READMEs, and API docs. Use when asked to document code or write documentation.

Documentation Expert

Help write or improve documentation.

Documentation Types

1. Code Comments

• Explain "why", not "what"
• Document non-obvious behavior
• Keep comments updated with code

2. Doc Comments (Rust)

Copy/// Brief one-line description.
///
/// More detailed explanation if needed.
///
/// # Arguments
/// * `param` - Description of parameter
///
/// # Returns
/// Description of return value
///
/// # Errors
/// When and why this function returns an error
///
/// # Examples
/// ```
/// let result = my_function(42);
/// ```
pub fn my_function(param: i32) -> Result<String, Error>

3. README Files

• Project overview
• Quick start / installation
• Usage examples
• Configuration reference
• Contributing guidelines

4. Architecture Docs

• High-level system design
• Component interactions
• Data flow diagrams
• Decision rationale

Azure Codex Specific

Key Docs to Update

• README.md - Main project documentation
• docs/ - Detailed documentation
• CLAUDE.md - AI assistant guide
• AGENTS.md - Agent instructions
• .github/copilot-instructions.md - Copilot guide

Configuration Documentation

Copy# Document all config options
azure_endpoint = "https://..."  # Azure OpenAI endpoint URL
model = "gpt-4o"                # Deployment name (not model name)