| 1 | # Skills Generation Information |
| 2 | |
| 3 | This document contains information about how these skills were generated and how to keep them synchronized with the documentation. |
| 4 | |
| 5 | ## Generation Details |
| 6 | |
| 7 | **Generated from documentation at:** |
| 8 | - **Commit SHA**: `9d30081469cd7ed08586bb8973649a88567cfa25` |
| 9 | - **Short SHA**: `9d300814` |
| 10 | - **Date**: 2026-01-13 15:41:28 +0900 |
| 11 | - **Version**: v52.11.3 |
| 12 | - **Commit**: chore: release v52.11.3 |
| 13 | |
| 14 | **Source documentation:** |
| 15 | - Main docs: `/docs` folder |
| 16 | |
| 17 | **Generation date**: 2026-01-26 |
| 18 | |
| 19 | ## Structure |
| 20 | |
| 21 | ``` |
| 22 | skills/ |
| 23 | ├── GENERATION.md # This file |
| 24 | └── slidev/ |
| 25 | ├── SKILL.md # Table-based reference to all features |
| 26 | └── references/ # Agent-optimized reference files |
| 27 | ``` |
| 28 | |
| 29 | ## File Naming Convention |
| 30 | |
| 31 | Files are prefixed by category: |
| 32 | - `core-*` - Core documentation (syntax, config, CLI, etc.) |
| 33 | - `code-*` - Code block features |
| 34 | - `editor-*` - Editor integrations |
| 35 | - `diagram-*` - Diagram and math support |
| 36 | - `layout-*` - Layout and positioning |
| 37 | - `style-*` - Styling features |
| 38 | - `animation-*` - Animation features |
| 39 | - `syntax-*` - Markdown syntax extensions |
| 40 | - `presenter-*` - Presenter mode features |
| 41 | - `build-*` - Build and export features |
| 42 | - `tool-*` - CLI tools |
| 43 | - `api-*` - API and hooks |
| 44 | |
| 45 | ## How Skills Were Generated |
| 46 | |
| 47 | The Slidev skills were created by: |
| 48 | |
| 49 | 1. **Reading all documentation** from `/docs` folder: |
| 50 | - `/docs/guide/*.md` - Core guides (syntax, animations, layouts, etc.) |
| 51 | - `/docs/builtin/*.md` - Built-in features (CLI, components, layouts) |
| 52 | - `/docs/features/*.md` - Individual features (43 files) |
| 53 | - `/docs/custom/*.md` - Customization options |
| 54 | |
| 55 | 2. **Creating table-based SKILL.md**: Main skill file with: |
| 56 | - Quick start and basic syntax |
| 57 | - Core references table (syntax, animations, config, CLI, etc.) |
| 58 | - Feature reference tables by category |
| 59 | - Links to detailed reference files |
| 60 | |
| 61 | 3. **Creating core documentation references** (10 files): |
| 62 | - `core-syntax.md` - Markdown syntax from guide/syntax.md |
| 63 | - `core-animations.md` - Animation system from guide/animations.md |
| 64 | - `core-headmatter.md` - Deck config from custom/index.md |
| 65 | - `core-frontmatter.md` - Per-slide config from custom/index.md |
| 66 | - `core-cli.md` - CLI commands from builtin/cli.md |
| 67 | - `core-components.md` - Built-in components from builtin/components.md |
| 68 | - `core-layouts.md` - Built-in layouts from builtin/layouts.md |
| 69 | - `core-exporting.md` - Export options from guide/exporting.md |
| 70 | - `core-hosting.md` - Deployment from guide/hosting.md |
| 71 | - `core-global-context.md` - Navigation API from guide/global-context.md |
| 72 | |
| 73 | 4. **Creating feature references** (41 files): |
| 74 | - Each feature from `/docs/features/` rewritten for agent consumption |
| 75 | - Concise, actionable format |
| 76 | - Clear code examples |
| 77 | - No unnecessary prose |
| 78 | - Prefixed by category |
| 79 | |
| 80 | ## Updating Skills (For Future Agents) |
| 81 | |
| 82 | When Slidev documentation changes, follow these steps to update the skills: |
| 83 | |
| 84 | ### 1. Check for Documentation Changes |
| 85 | |
| 86 | ```bash |
| 87 | # Get changes in docs since generation |
| 88 | git diff sha_of_last_generation..HEAD -- docs/ |
| 89 | |
| 90 | # List changed files |
| 91 | git diff --name-only sha_of_last_generation..HEAD -- docs/ |
| 92 | |
| 93 | # Get summary of changes |
| 94 | git log --oneline sha_of_last_generation..HEAD -- docs/ |
| 95 | ``` |
| 96 | |
| 97 | ### 2. Identify What Changed |
| 98 | |
| 99 | Focus on these documentation areas: |
| 100 | - `/docs/guide/` - Core concepts and workflows |
| 101 | - `/docs/builtin/` - Built-in features (CLI, components, layouts) |
| 102 | - `/docs/features/` - Individual features |
| 103 | - `/docs/custom/` - Configuration and customization |
| 104 | |
| 105 | ### 3. Update Skills |
| 106 | |
| 107 | **For minor changes** (typos, clarifications, small additions): |
| 108 | - Update the relevant section in `SKILL.md` |
| 109 | - Update corresponding file in `references/` if needed |
| 110 | |
| 111 | **For major changes**: |
| 112 | - Read the changed documentation files |
| 113 | - Update `SKILL.md` sections: |
| 114 | - Add new changes to appropriate sections |
| 115 | - Update examples if APIs changed |
| 116 | - Add to "Common Patterns" if applicable |
| 117 | - Update or add files in `references/` |
| 118 | |
| 119 | **For new features**: |
| 120 | - Add documentation file to `references/` with appropriate prefix |
| 121 | - Do not just copy the file from the docs, rewrite it for agent consumption |
| 122 | - Add entry in `SKILL.md` with: |
| 123 | - Brief description in relevant section |
| 124 | - Code example |
| 125 | - Best practices if applicable |
| 126 | - Reference to detailed docs |
| 127 | |
| 128 | ### 4. Incremental Sync Process |
| 129 | |
| 130 | ```bash |
| 131 | # 1. Check what docs changed |
| 132 | git diff sha_of_last_generation..HEAD -- docs/ > docs_changes.patch |
| 133 | |
| 134 | # 2. Review the changes |
| 135 | cat docs_changes.patch |
| 136 | |
| 137 | # 4. Update references based on changes |
| 138 | |
| 139 | # 5. Update SKILL.md based on changes |
| 140 | |
| 141 | # 6. Update this file with new SHA |
| 142 | git rev-parse HEAD # Get new SHA |
| 143 | # Update GENERATION.md with new SHA |
| 144 | ``` |
| 145 | |
| 146 | ### 5. Sync Checklist |
| 147 | |
| 148 | - [ ] Read diff of docs since last generation |
| 149 | - [ ] Identify new features added |
| 150 | - [ ] Identify changed/deprecated features |
| 151 | - [ ] Update `SKILL.md` with changes: |
| 152 | - [ ] Add new features to appropriate sections |
| 153 | - [ ] Update changed examples |
| 154 | - [ ] Remove deprecated features |
| 155 | - [ ] Update best practices if needed |
| 156 | - [ ] Update `references/` folder: |
| 157 | - [ ] Add new feature docs with category prefix |
| 158 | - [ ] Update changed feature docs |
| 159 | - [ ] Remove deprecated feature docs |
| 160 | - [ ] Update `index.md` if files added/removed |
| 161 | - [ ] Update this `GENERATION.md` with new SHA |
| 162 | |
| 163 | ## Maintenance Notes |
| 164 | |
| 165 | ### Key Sections to Keep Updated |
| 166 | |
| 167 | 1. **Core Concepts** - Only update for fundamental changes |
| 168 | 2. **Best Practices** - Update when new patterns emerge |
| 169 | 3. **Common Patterns** - Add new patterns as documentation shows them |
| 170 | 4. **Configuration** - Update when new options added |
| 171 | 5. **Troubleshooting** - Add new issues/solutions as they appear |
| 172 | 6. **References** - Always keep in sync with `/docs/features/` |
| 173 | |
| 174 | ### When to Regenerate Completely |
| 175 | |
| 176 | Consider full regeneration when: |
| 177 | - Major version update (v1.x → v2.x) |
| 178 | - Complete documentation restructure |
| 179 | - Multiple breaking changes |
| 180 | - More than 30% of docs changed |
| 181 | |
| 182 | ### Style Guidelines |
| 183 | |
| 184 | When updating, maintain style: |
| 185 | - Practical, actionable guidance |
| 186 | - ✅ Good vs ❌ Bad examples |
| 187 | - Focus on common use cases |
| 188 | - Concise explanations |
| 189 | - Real-world patterns |
| 190 | - Reference detailed docs for deep dives |
| 191 | |
| 192 | ## Version History |
| 193 | |
| 194 | | Date | SHA | Version | Changes | |
| 195 | |------------|----------|-----------|---------| |
| 196 | | 2026-01-26 | 9d300814 | v52.11.3 | Initial generation from docs | |
| 197 | |
| 198 | ## Agent Instructions Summary |
| 199 | |
| 200 | **For future agents updating these skills:** |
| 201 | |
| 202 | 1. Run `git diff sha_of_last_generation..HEAD -- docs/` to see all documentation changes |
| 203 | 2. Read changed files to understand what's new or modified |
| 204 | 3. Update `SKILL.md` by: |
| 205 | - Adding new features to appropriate sections |
| 206 | - Updating examples for changed APIs |
| 207 | - Removing deprecated features |
| 208 | - Adding new best practices or patterns |
| 209 | 4. Sync `references/` folder with `/docs/features/` |
| 210 | 5. Update this file with new SHA and version |
| 211 | 6. Test that skill content is accurate and follows style |
| 212 | |
| 213 | **Remember**: The goal is incremental updates, not complete rewrites. Only change what needs to change based on documentation diffs. |
| 214 | |
| 215 | ## Questions? |
| 216 | |
| 217 | If you're unsure about whether changes warrant updates: |
| 218 | - **Small changes** (typos, clarifications): Optional, can skip |
| 219 | - **New features**: Must add to skills |
| 220 | - **Changed APIs**: Must update examples |
| 221 | - **Deprecated features**: Must remove or mark as deprecated |
| 222 | - **New best practices**: Should add to relevant sections |
| 223 | |
| 224 | --- |
| 225 | |
| 226 | Last updated: 2026-01-26 |
| 227 | Current SHA: 9d300814 |
| 228 |