Use when creating, organizing, or working with documentation in a smart-docs managed folder. Provides patterns for structuring docs, using frontmatter, and leveraging auto-load features.
Provides patterns for organizing documentation in smart-docs managed folders, including hierarchical structure, frontmatter configuration, and auto-load settings for AI agent integration. Use when creating or structuring docs to ensure consistency and enable automatic context loading.
/plugin marketplace add hhopkins95/smart-docs/plugin install smart-docs@smart-docs-mpThis skill inherits all available tools. When active, it can use any tool Claude has access to.
When working with documentation in a smart-docs managed project, follow these patterns to ensure consistency and enable AI agent integration.
The documentation folder path is available via SMART_DOCS_PATH environment variable.
Organize documentation hierarchically by audience and topic:
docs/
├── index.md # Overview and navigation
├── getting-started/ # Onboarding content
│ ├── installation.md
│ └── quickstart.md
├── guides/ # Task-oriented guides
│ ├── common-tasks.md
│ └── advanced-usage.md
├── reference/ # API and technical reference
│ ├── api.md
│ └── configuration.md
└── contributing/ # For contributors
└── guidelines.md
Conventions:
Every markdown file should have frontmatter with at minimum:
---
title: Human-Readable Title
description: Brief summary for search and previews
---
For documents that should be automatically loaded into AI agent context:
---
title: Code Style Guide
description: Formatting and style rules for this project
autoLoad: true
autoLoadPriority: 3
agentRole: instructions
---
Field Reference:
| Field | Type | Description |
|---|---|---|
autoLoad | boolean | Set true to inject at session start |
autoLoadPriority | number (1-10) | Lower = loads first |
agentRole | string | reference, instructions, or example |
Good candidates for autoLoad: true:
Avoid auto-loading:
When writing documentation that will be consumed by AI agents:
---
title: API Response Format
autoLoad: true
agentRole: instructions
---
# API Response Format
All API endpoints MUST return responses in this format:
## Success Response
\`\`\`json
{
"data": { /* response payload */ },
"meta": {
"timestamp": "ISO8601 date"
}
}
\`\`\`
## Error Response
\`\`\`json
{
"error": {
"code": "ERROR_CODE",
"message": "Human-readable message"
}
}
\`\`\`
## Rules
- Never return raw arrays at the top level
- Always include `meta.timestamp`
- Error codes must be SCREAMING_SNAKE_CASE
Use relative paths for links between documents:
See [Installation Guide](../getting-started/installation.md) for setup.
When creating or modifying docs programmatically, use the smart-docs API:
GET /api/docs/tree - List all documentsGET /api/docs/content?path=<path> - Read a documentPUT /api/docs/content?path=<path> - Update a documentPOST /api/docs/content - Create a new documentDELETE /api/docs/content?path=<path> - Delete a document