Notre avis
Génère un site de tutoriel VitePress qui explique l'implémentation interne d'un code source, avec des diagrammes d'architecture et des références de code.
Points forts
- Automatise la création de documentation éducative structurée à partir du code source.
- Utilise des diagrammes Mermaid pour l'architecture visuelle.
- Génère des sites VitePress déployables de manière autonome.
- Prend en charge plusieurs langages (Go, TypeScript, Python).
Limites
- Nécessite une relecture manuelle minutieuse du contenu généré pour en assurer l'exactitude.
- Ne génère que du contenu prioritairement en chinois (peut nécessiter une adaptation pour d'autres langues).
- Dépend de la qualité de la structure et des commentaires du code source.
À utiliser lorsque vous devez créer un tutoriel pédagogique approfondi pour que les développeurs comprennent l'architecture interne et les détails d'implémentation d'un codebase.
Ne pas utiliser pour une documentation utilisateur 'comment utiliser' ou pour des codebases très petites et triviales à comprendre sans tutoriel.
Analyse de sécurité
SûrThe skill only reads source files and generates static documentation (Markdown, config files). It does not execute any code, run shell commands, access the network, or modify files outside the specified output directory. There is no instruction to handle secrets or perform destructive actions.
Aucun point d'attention détecté
Exemples
/vitepress-tutorial ./apps/runner ./tutorials/runner-guide/vitepress-tutorial ./pkg/sandboxVitePress Source Tutorial Generator
Generate VitePress documentation sites for source code learning and analysis.
Overview
This skill creates standalone VitePress tutorial sites that teach developers how a codebase works internally. Unlike user documentation that explains "how to use", these tutorials explain "how it's implemented".
Usage
/vitepress-tutorial [source-path] [output-path]
Examples:
/vitepress-tutorial ./apps/runner ./tutorials/runner-guide/vitepress-tutorial ./pkg/sandbox
Workflow
Phase 1: Analysis
- Explore the specified source directory
- Identify key components, patterns, and architecture
- Map dependencies and data flows
- Output: Module inventory and architecture overview
User checkpoint: Confirm scope and focus areas
Phase 2: Planning
- Generate tutorial outline based on analysis
- Determine chapter structure and navigation
- Identify code sections to highlight
- Output: Tutorial structure document
User checkpoint: Approve outline before generation
Phase 3: Generation
- Create VitePress project skeleton using @project-structure.md
- Configure VitePress using @config-template.md
- Generate tutorial content following @content-guidelines.md
- Build and verify
Output Structure
{output-path}/
├── package.json
├── docs/
│ ├── .vitepress/
│ │ └── config.ts
│ ├── index.md # Homepage
│ ├── introduction/
│ │ ├── overview.md # Project overview
│ │ └── architecture.md # Architecture diagram
│ └── {modules}/ # One directory per module
│ ├── index.md
│ └── {topics}.md
└── README.md
Features
- Source References: Auto-generate
Source: path/to/file.go:123annotations - Mermaid Diagrams: Architecture, sequence, and flow diagrams
- Code Highlighting: Go, TypeScript, Python with line highlighting
- Chinese-first: Content in Chinese, code comments in English
- Standalone Deploy: Ready for Vercel, Netlify, or GitHub Pages
Configuration
The skill reads project context to customize output:
| Context | Effect |
|---------|--------|
| Go project | Uses Go code blocks, references .go files |
| TypeScript | Uses TS blocks, references .ts/.tsx files |
| Monorepo | Detects apps/, packages/ structure |
Instructions
When executing this skill:
- Always explore first - Read source files before writing tutorials
- Reference actual code - Include real code snippets with file paths
- Use Mermaid for architecture - Visual diagrams aid understanding
- Keep chapters focused - One concept per file, ~200-400 lines
- Link between chapters - Use VitePress prev/next navigation
- Include API tables - Summarize endpoints, functions, types
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.