Skip to content

Commit 90657ad

Browse files
Update file
1 parent 0d9fa47 commit 90657ad

File tree

1 file changed

+44
-37
lines changed

1 file changed

+44
-37
lines changed
Lines changed: 44 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,61 @@
1-
# How to Use and Customize the "Populate External Docs" Command in the VS Code Extension
1+
# Dev-Docs VS Code Extension: Streamlining Documentation for Your Codebase
22

3-
## Step 1: Access the Command
3+
The Dev-Docs VS Code extension helps developers streamline the process of creating and managing documentation for their codebase. This guide provides an overview of key features and how to use them.
44

5-
1. Open your VS Code workspace
6-
2. Press `Cmd+Shift+P` (Mac) or `Ctrl+Shift+P` (Windows/Linux) to open the command palette
7-
3. Type "Populate External Docs" and select the command
5+
## Key Features
86

9-
![Command Palette](https://docs.dev/img/populate-external-docs-command.png)
7+
### Automatic Documentation Generation
108

11-
## Step 2: Customizing Generation with dev-docs.json
9+
![Auto-generate docs](https://example.com/auto-generate-docs.png)
1210

13-
To customize the documentation generation, modify the `dev-docs.json` file in your project root:
11+
The extension can automatically generate documentation by analyzing your code and extracting relevant information.
1412

15-
1. Create or open `dev-docs.json`
16-
2. Add an `ai` object with customization options
13+
### AI-Assisted Editing
1714

18-
Example `dev-docs.json`:
15+
![AI editing](https://example.com/ai-editing.png)
1916

20-
```json
21-
{
22-
"ai": {
23-
"internalTypeFilters": ["class", "method", "function"],
24-
"codeFilters": [],
25-
"nameFilters": [],
26-
"docSubFolder": "api/",
27-
"merge": true,
28-
"externalDocPrompt": "Generate comprehensive API documentation"
29-
}
30-
}
31-
```
17+
Get AI-powered suggestions and auto-completion as you write documentation to improve quality and consistency.
18+
19+
### External Documentation Management
20+
21+
![External docs](https://example.com/external-docs.png)
22+
23+
Easily manage external documentation separate from your code while keeping it in sync.
3224

33-
Key customization options:
25+
### Version Control Integration
3426

35-
- `internalTypeFilters`: Specify which code elements to document
36-
- `docSubFolder`: Set the output folder for generated docs
37-
- `merge`: Combine multiple elements into a single document
38-
- `externalDocPrompt`: Customize the AI prompt for doc generation
27+
![Version control](https://example.com/version-control.png)
3928

40-
![dev-docs.json config](https://docs.dev/img/dev-docs-json-config.png)
29+
Documentation changes are tracked alongside code changes in your version control system.
4130

42-
The `generateBySymbols` function in `src/AiServices.ts` uses these settings to generate documentation.
31+
## Using the Extension
4332

44-
## Step 3: Review and Edit
33+
1. Install the Dev-Docs extension from the VS Code marketplace
34+
2. Open your project in VS Code
35+
3. Access Dev-Docs commands via:
36+
- Command palette (Cmd/Ctrl + Shift + P)
37+
- Context menu (right-click)
38+
- Dev-Docs sidebar
4539

46-
After running the command:
40+
![Accessing commands](https://example.com/accessing-commands.png)
4741

48-
1. Check the `docs` folder (or your specified `docSubFolder`) for generated files
49-
2. Review and edit the generated content as needed
50-
3. Commit changes to your repository
42+
4. Configure options in dev-docs.json file
43+
5. Use commands like "Generate Docs" to create documentation
5144

52-
![Generated docs](https://docs.dev/img/generated-docs-folder.png)
45+
## Configuration Options
46+
47+
Key options in dev-docs.json:
48+
49+
```json
50+
{
51+
"ai": {
52+
"components": {
53+
"template": "path/to/template.md"
54+
},
55+
"docPath": "docs/api",
56+
"branch": "main"
57+
}
58+
}
59+
```
5360

54-
By following these steps and customizing the `dev-docs.json`, you can efficiently generate and manage external documentation for your project using the VS Code extension.
61+
Customize settings to fit your project's documentation needs.

0 commit comments

Comments
 (0)