|
| 1 | +# Advanced Features |
| 2 | + |
| 3 | +## AI-Powered Documentation Generation |
| 4 | + |
| 5 | +Dev-Docs leverages advanced AI capabilities to automatically generate comprehensive documentation for your codebase. Some key features include: |
| 6 | + |
| 7 | +- Intelligent analysis of code structure and patterns |
| 8 | +- Natural language summaries of functions, classes and modules |
| 9 | +- Automatic generation of code examples and usage instructions |
| 10 | +- Ability to ask questions about your code and receive AI-generated answers |
| 11 | + |
| 12 | +To customize the AI generation, you can modify options in your `dev-docs.json` file: |
| 13 | + |
| 14 | +```json |
| 15 | +{ |
| 16 | + "ai": { |
| 17 | + "contextDirs": ["src", "lib"], |
| 18 | + "internalTypeFilters": ["class", "method", "function"], |
| 19 | + "codeFilters": ["async function", "export default"], |
| 20 | + "nameFilters": ["handleSubmit", "render"], |
| 21 | + "contextPrompt": "Generate comprehensive API documentation" |
| 22 | + } |
| 23 | +} |
| 24 | +``` |
| 25 | + |
| 26 | +## Multi-File Context Generation |
| 27 | + |
| 28 | +Generate high-level context summaries for entire folders or multiple files at once using the "Generate Context for Multiple Documents" command. This is useful for quickly understanding the purpose and structure of different parts of your project. |
| 29 | + |
| 30 | +## OpenAPI Specification Generation |
| 31 | + |
| 32 | +Automatically generate OpenAPI (Swagger) specifications from your API code using the `devdocs.generateAPIDocumentation` command. This creates a Postman collection and OpenAPI spec to document your API endpoints. |
| 33 | + |
| 34 | +## Markdown Documentation Mode |
| 35 | + |
| 36 | +Enable Markdown mode to write documentation directly alongside your code while keeping it visually separate. Use the "Turn on Markdown Mode" command to activate this feature. |
| 37 | + |
| 38 | +## Missing Documentation Detection |
| 39 | + |
| 40 | +The "Find Missing Documentation" command uses AI to analyze your existing docs and codebase to identify potential documentation gaps. It will suggest new documentation topics and create GitHub issues for each suggestion. |
| 41 | + |
| 42 | +## Cloud Sync and Collaboration |
| 43 | + |
| 44 | +Sync your Dev-Docs to the Dev-Docs Cloud to enable team collaboration on documentation. Use the Dev-Docs web application to manage your documentation wiki across your organization. |
| 45 | + |
| 46 | +## Customizable Documentation Templates |
| 47 | + |
| 48 | +Create custom documentation templates to standardize the structure and formatting of your generated docs. Specify template locations in your `dev-docs.json`: |
| 49 | + |
| 50 | +```json |
| 51 | +{ |
| 52 | + "ai": { |
| 53 | + "components": { |
| 54 | + "template": "docs/templates/component.md" |
| 55 | + } |
| 56 | + } |
| 57 | +} |
| 58 | +``` |
| 59 | + |
| 60 | +## Integration with CI/CD |
| 61 | + |
| 62 | +Integrate Dev-Docs into your CI/CD pipelines to automatically generate and update documentation on every code change or release. This ensures your docs always stay in sync with your codebase. |
| 63 | + |
| 64 | +For more details on these advanced features, refer to the specific command documentation or reach out to Dev-Docs support. |
0 commit comments