Skip to content

Commit 3f4475e

Browse files
authored
Merge pull request #260 from team-dev-docs/docs_internal-docs_generate_some_context_on_multiple_files.mdm2zilw09-wtuif
Dev-Docs Update
2 parents 19f432b + bb83c82 commit 3f4475e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
2+
3+
## Step 1: Open the project
4+
![Step 1](/img/generate_some_context_on_multiple_files/step_1.png)
5+
6+
Open your project in the code editor. The image shows a dark-themed code editor with a file explorer on the left and a JavaScript file open in the main pane.
7+
## Step 2: Access the Dev-Docs menu
8+
![Step 2](/img/generate_some_context_on_multiple_files/step_2.png)
9+
10+
Look for the "DEV-DOCS: YOUR DEV-DOCS" panel on the left side of the editor. You'll see several green buttons, including "Generate Context".
11+
## Step 3: Click on "Generate Context"
12+
![Step 3](/img/generate_some_context_on_multiple_files/step_3.png)
13+
14+
Click on the "Generate Context" button to start the process of creating context from multiple files.
15+
## Step 4: Wait for the loading process
16+
![Step 4](/img/generate_some_context_on_multiple_files/step_4.png)
17+
18+
After clicking "Generate Context", you may see a loading indicator at the bottom of the screen. Wait for this process to complete.
19+
## Step 5: Select files for context generation
20+
![Step 5](/img/generate_some_context_on_multiple_files/step_5.png)
21+
22+
A new panel will appear on the right side of the editor titled "Your Dev-Docs". Here, you can select the files you want to use as context for generating documentation. The image shows several files already selected, including index.js, package.json, test.js, and tests/removeBackground.test.js.
23+
## Step 6: Choose where to create the context
24+
![Step 6](/img/generate_some_context_on_multiple_files/step_6.png)
25+
26+
In the same panel, you'll see options for where the context should be created. The choices are "codebase" and "user-facing docs". Select your preferred option.
27+
## Step 7: Generate the new document
28+
![Step 7](/img/generate_some_context_on_multiple_files/step_7.png)
29+
30+
Once you've selected the files and chosen where to create the context, click on the "Generate New Doc" button to create your new document with the context from the selected files.
31+
32+

0 commit comments

Comments
 (0)