Documentation
Generate Markdown documentation.
Sections
- •Overview - What it does and why (2-3 sentences)
- •Architecture - Mermaid diagram if multi-component
- •Usage - Working code examples
- •Configuration - Environment variables table
- •API Reference - Function signatures with examples (if applicable)
Templates
Configuration Table
markdown
| Variable | Required | Default | Description | |----------|----------|---------|-------------| | `DATABASE_URL` | Yes | - | PostgreSQL connection string | | `LOG_LEVEL` | No | `info` | Logging verbosity |
Mermaid Diagram
markdown
```mermaid
flowchart LR
A[Client] --> B[API Gateway]
B --> C[Service]
C --> D[(Database)]
code
### Function Reference
```markdown
### `create_user(email: str, name: str) -> User`
Create a new user account.
**Parameters:**
- `email` - User email (must be unique)
- `name` - Display name
**Returns:** `User` object
**Raises:** `DuplicateError` if email exists
**Example:**
```python
user = create_user("alice@example.com", "Alice")
code
## Output Markdown only. Explain *why* something exists, not just *what*.