Dev-Docs Quick Start Guide
1. Install the VS Code Extension
Install the Dev-Docs VS Code extension from the Visual Studio Code Marketplace.
2. Set Up Your Repository
- Open your project in VS Code
- Click the Dev-Docs icon in the Activity Bar
- Click "Setup my repo"
- Click "Generate Context" to create initial documentation
3. Generate Documentation
From VS Code:
- Right-click in a code file
- Select "Generate Documentation"
- Or use the shortcut:
- Mac:
Shift + Command + D
- Windows/Linux:
Shift + Ctrl + D
- Mac:
From GitHub:
- Install the Dev-Docs GitHub App
- Configure your
dev-docs.json
file:
{
"gitHubApp": {
"workflows": ["generateDocs"]
}
}
- Commit and push changes to trigger automatic doc generation
4. Customize Generation
Edit dev-docs.json
to customize AI-powered doc generation:
{
"ai": {
"internalTypeFilters": ["class", "method", "function"],
"contextPrompt": "Generate comprehensive API documentation",
"defaultLength": "3-5 Sentences"
}
}
5. View and Edit Documentation
- Check the
docs
folder for generated Markdown files - Use the web editor to make changes and add content
- Leverage AI features like "Generate Content from Existing Content"
For more details, see the full documentation.