Skip to content

Commit da19ca2

Browse files
committed
Updated developer docs: 2025-02-10T18:15:51+0000
1 parent f167105 commit da19ca2

File tree

6 files changed

+34
-15
lines changed

6 files changed

+34
-15
lines changed

docs/VS Code Extension/Dev-Docs-Quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ sidebar_position: 1
33
---
44

55

6-
# Quickstart
6+
# VS Code Quickstart
77

8-
See Dev-Docs in action in just a under five minutes! First, you'll need an account. If you haven't made one yet, head to [dev-docs.io](https://www.dev-docs.io/) to create a free account in just a few clicks by logging in with your GitHub (no cc required). If you already have one then you're ready to go! Woohoo!
8+
See Dev-Docs in action in just a few minutes! First, you'll need an account. If you haven't made one yet, head to [dev-docs.io](https://www.dev-docs.io/) to create a free account by logging in with your GitHub (no cc required). If you already have one then you're ready to go!
99

1010
<br></br>
1111

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,49 @@
1-
1+
---
2+
sidebar_position: 5
3+
---
24

35
# Generate Context on Multiple Files
46

57
## Step 1: Open the Dev-Docs Extension
6-
![Step 1](/img/generate_context_on_multiple_files/step_1.png)
78

89
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.
910

1011
## Step 2: Navigate to the Index File
11-
![Step 2](/img/generate_context_on_multiple_files/step_2.png)
1212

1313
Navigate to the main index.js file of your project. This file typically contains the core functionality and imports.
1414

15+
![Step 2](/img/generate_context_on_multiple_files/step_2.png)
16+
17+
1518
## Step 3: Access the "Generate Context" Feature
16-
![Step 3](/img/generate_context_on_multiple_files/step_3.png)
1719

1820
Click on the "Generate Context" button in the Dev-Docs panel. This will open up the context generation interface.
1921

22+
![Step 3](/img/generate_context_on_multiple_files/step_3.png)
23+
2024
## Step 4: Select Multiple Files
21-
![Step 4](/img/generate_context_on_multiple_files/step_4.png)
2225

2326
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.
2427

28+
![Step 4](/img/generate_context_on_multiple_files/step_4.png)
29+
2530
## Step 5: Choose Context Creation Location
26-
![Step 5](/img/generate_context_on_multiple_files/step_5.png)
2731

2832
Decide where the context should be created. You have options like "codebase" or "user-facing docs". Select the appropriate option for your needs.
2933

34+
35+
![Step 5](/img/generate_context_on_multiple_files/step_5.png)
36+
37+
3038
## Step 6: Generate the New Document
31-
![Step 6](/img/generate_context_on_multiple_files/step_6.png)
3239

3340
Click the "Generate New Doc" button to create the context document based on the selected files.
3441

42+
![Step 6](/img/generate_context_on_multiple_files/step_6.png)
43+
44+
3545
## Step 7: View Generated Context
36-
![Step 7](/img/generate_context_on_multiple_files/step_7.png)
3746

3847
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.
3948

40-
49+
![Step 7](/img/generate_context_on_multiple_files/step_7.png)

docs/VS Code Extension/Generate some context on a folder.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
1+
---
2+
sidebar_position: 4
3+
---
24

35
# How to Generate Context on a Folder in VS Code
46

57
## Step 1: Open the Folder in VS Code
68

79
![Open folder in VS Code](/img/generate_some_context_on_a_folder/step_1.png)
810

9-
First, open your project folder in Visual Studio Code. You should see the folder structure in the Explorer pane on the left side of the window. In this example, we can see a Node.js project with various files and folders.
11+
First, open your project folder in VS Code. You should see the folder structure in the Explorer pane on the left side of the window. In this example, we can see a Node.js project with various files and folders.
1012

1113
## Step 2: Generate High Level Context for the Folder
1214

docs/VS Code Extension/Generate-Documentation-With-AI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 3
33
---
44

55

docs/VS Code Extension/Getting-Started.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Getting Started with Dev-Docs
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Setting up the VS Code Extension
26

37
Dev-Docs is a powerful VS Code extension that helps you generate and manage documentation for your codebase. This guide will walk you through the basic setup and usage to get you up and running quickly.
48

docs/VS Code Extension/Use our Vs Code Extension with continue.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position:
3+
---
4+
15
# Using Dev-Docs with Continue in VS Code
26

37
## Step 1: Open the Continue Extension

0 commit comments

Comments
 (0)