Skip to content

Commit 192326e

Browse files
authored
Merge pull request #238 from team-dev-docs/dev-docs-Dev-Docs_Update_2024-10-22_20-36-27
Dev-Docs Update
2 parents 2f40048 + a8ab974 commit 192326e

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
2+
3+
# Using the "Generate High Level Context for the Folder" Command
4+
5+
## Overview
6+
7+
The "Generate High Level Context for the Folder" command is a powerful feature in Dev-Docs that allows you to automatically generate high-level documentation for an entire folder in your project. This guide will walk you through how to use this command and customize its behavior using the `dev-docs.json` configuration file.
8+
9+
## Step-by-Step Guide
10+
11+
### 1. Right-Click on a Folder
12+
In your VS Code file explorer, right-click on the folder you want to document.
13+
14+
### 2. Select the Command
15+
From the context menu, choose "Generate High Level Context for the Folder".
16+
17+
### 3. Wait for Processing
18+
The extension will analyze the folder contents and generate documentation. This may take a moment depending on the folder size and complexity.
19+
20+
### 4. Review Generated Documentation
21+
Once complete, a new Markdown file will be created in your `dev-docs` folder, containing the high-level context for the selected folder.
22+
23+
## Customizing with dev-docs.json
24+
25+
You can customize the behavior of this command by modifying the `dev-docs.json` file in your project root. Here are some key configurations:
26+
27+
### 1. Customizing the Context Prompt
28+
29+
```json
30+
{
31+
"ai": {
32+
"contextPrompt": "your_custom_prompt_here"
33+
}
34+
}
35+
```
36+
37+
This allows you to specify a custom prompt for generating the context. You can also use a Markdown file for more complex prompts:
38+
39+
```json
40+
{
41+
"ai": {
42+
"contextPrompt": "dev-docs/prompt.md"
43+
}
44+
}
45+
```
46+
47+
### 2. Specifying Context Directories
48+
49+
```json
50+
{
51+
"ai": {
52+
"contextDirs": ["src", "lib", "utils"]
53+
}
54+
}
55+
```
56+
57+
This limits the context generation to specific directories, which is useful for large projects.
58+
59+
60+
61+
62+

0 commit comments

Comments
 (0)