Skip to content

Commit 34691ab

Browse files
authored
Merge pull request #240 from team-dev-docs/generate_context_on_a_codefilem2m6kpj4-07i8n
Dev-Docs Update
2 parents 9945368 + 74c4a03 commit 34691ab

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
2+
3+
## Step 1: Locate the Code File
4+
5+
Find the code file you want to generate context for in your development environment.
6+
7+
![image for /img/generate_context_on_a_codefile/step_1](/img/generate_context_on_a_codefile/step_1.png)
8+
## Step 2: Open the Context Menu
9+
10+
Right-click on the code file to open the context menu.
11+
12+
![image for /img/generate_context_on_a_codefile/step_2](/img/generate_context_on_a_codefile/step_2.png)
13+
## Step 3: Access the Dev-Docs Submenu
14+
15+
In the context menu, find and hover over the "dev-docs" submenu.
16+
17+
![image for /img/generate_context_on_a_codefile/step_3](/img/generate_context_on_a_codefile/step_3.png)
18+
## Step 4: Select Generate Context Option
19+
20+
Click on the "Generate Context" option within the dev-docs submenu.
21+
22+
![image for /img/generate_context_on_a_codefile/step_4](/img/generate_context_on_a_codefile/step_4.png)
23+
## Step 5: View Generated Context File
24+
25+
A new file named "context-[filename].md" will appear in your file explorer.
26+
27+
![image for /img/generate_context_on_a_codefile/step_5](/img/generate_context_on_a_codefile/step_5.png)
28+
## Step 6: Review the Generated Context
29+
30+
Open the newly created markdown file to view the high-level overview of your code.
31+
32+
![image for /img/generate_context_on_a_codefile/step_6](/img/generate_context_on_a_codefile/step_6.png)
33+
## Step 7: Open the Dev-Docs editor
34+
35+
Right-click on the generated markdown file to open the markdown file in dev-docs editor.
36+
37+
![image for /img/generate_context_on_a_codefile/step_8](/img/generate_context_on_a_codefile/step_8.png)
38+
## Step 8: Examine the Context Details
39+
40+
Review the generated context, including the last update time, overview, main code object, and methods.
41+
42+
![image for /img/generate_context_on_a_codefile/step_7](/img/generate_context_on_a_codefile/step_7.png)
43+
44+

0 commit comments

Comments
 (0)