Skip to content

Commit 636e0a8

Browse files
authored
Merge pull request #253 from team-dev-docs/docs_internal-docs_generate_context_on_multiple_files.mdm2z18s3j-zed9i
Dev-Docs Update
2 parents 3018c8c + b8a609b commit 636e0a8

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
2+
3+
# Generate Context on Multiple Files
4+
5+
## Step 1: Open the Dev-Docs Extension
6+
![Step 1](/img/generate_context_on_multiple_files/step_1.png)
7+
8+
Open the Dev-Docs extension in your IDE. You should see options like "Sign Out", "Generate Context", "Create Custom Doc", etc. on the left side.
9+
10+
## Step 2: Navigate to the Index File
11+
![Step 2](/img/generate_context_on_multiple_files/step_2.png)
12+
13+
Navigate to the main index.js file of your project. This file typically contains the core functionality and imports.
14+
15+
## Step 3: Access the "Generate Context" Feature
16+
![Step 3](/img/generate_context_on_multiple_files/step_3.png)
17+
18+
Click on the "Generate Context" button in the Dev-Docs panel. This will open up the context generation interface.
19+
20+
## Step 4: Select Multiple Files
21+
![Step 4](/img/generate_context_on_multiple_files/step_4.png)
22+
23+
In the "Generate a new document for your repo" section, select multiple files to use as context. In this example, "/index.js", "/package.json", "/test.js", and "/tests/removeB" are selected.
24+
25+
## Step 5: Choose Context Creation Location
26+
![Step 5](/img/generate_context_on_multiple_files/step_5.png)
27+
28+
Decide where the context should be created. You have options like "codebase" or "user-facing docs". Select the appropriate option for your needs.
29+
30+
## Step 6: Generate the New Document
31+
![Step 6](/img/generate_context_on_multiple_files/step_6.png)
32+
33+
Click the "Generate New Doc" button to create the context document based on the selected files.
34+
35+
## Step 7: View Generated Context
36+
![Step 7](/img/generate_context_on_multiple_files/step_7.png)
37+
38+
The generated context document will open, showing a summary of the selected files. In this example, it displays information about the package.json configuration file, including project metadata, scripts, and dependencies.
39+
40+

0 commit comments

Comments
 (0)