Skip to content

Commit 9e22210

Browse files
before using auditor
1 parent cfb20c9 commit 9e22210

33 files changed

+127
-0
lines changed

blog/Use Dev-Docs with Continue.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
title: Contextual documentation with Dev-Docs and Continue
3+
authors: andrew
4+
header_image: /img/dev-docs-assets/ClippedHeroBg.png
5+
text_color: white
6+
tags: [docs, seo, sales]
7+
---
8+
9+
# **Contextual documentation with Dev-Docs and Continue**
10+
11+
[Continue](https://www.continue.dev/) is the leading open-source AI code assistant. Its IDE extensions allow you to leverage AI in your code editor to ask questions about your codebase and generate code. What’s even more awesome is that it is extensible—for example, you can use any models you want with it!
12+
13+
<br></br>
14+
15+
[Dev-Docs](https://www.docs.dev/) is an AI developer tool that provides a VS Code extension for generating custom markdown documentation on your codebase that can be used by tools like Continue. Today, we are going to show how you can use Dev-Docs to generate custom, contextual documentation for a codebase, which can be used as context in Continue.
16+
17+
# Before you get started
18+
19+
Install Dev-Docs in VS Code
20+
21+
<br></br>
22+
23+
![step_3.png](/img/use_dev-docs_with_continue/step_3.png)
24+
25+
<br></br>
26+
27+
Install Continue in VS Code
28+
29+
<br></br>
30+
31+
![step_6.png](/img/use_dev-docs_with_continue/step_6.png)
32+
33+
<br></br>
34+
35+
# **Step 1: Open the Dev-Docs extension and sign in**
36+
37+
Select the “Dev-Docs” extension icon from the Activity Bar on the left and then “Sign In”
38+
39+
<br></br>
40+
41+
![image.png](/img/use_dev-docs_with_continue/step_8.png)
42+
43+
<br></br>
44+
45+
Once you are signed in, you will need to create an org name for your team. For example, our org name here is “devdocscontinueblog”
46+
47+
<br></br>
48+
49+
![step_11.png](/img/use_dev-docs_with_continue/step_11.png)
50+
51+
<br></br>
52+
53+
Step 2: Click the “Setup my repo” button and then the “Generate Context” button
54+
55+
<br></br>
56+
57+
![step_7.png](/img/use_dev-docs_with_continue/step_7.png)
58+
59+
<br></br>
60+
61+
This will create a `dev-docs.json` file and `dev-docs` folder in your repo
62+
63+
<br></br>
64+
65+
![step_14.png](/img/use_dev-docs_with_continue/step_14.png)
66+
67+
<br></br>
68+
69+
Select the "Generate Context" button
70+
71+
<br></br>
72+
73+
![step_15.png](/img/use_dev-docs_with_continue/step_15.png)
74+
75+
<br></br>
76+
77+
# **Step 3: Select the files you want to use and generate the contextual documentation[](https://www.docs.dev/docs/Internal-Docs/Use%20our%20Vs%20Code%20Extension%20with%20continue#step-4-select-files)**
78+
79+
<br></br>
80+
81+
Choose the files you want to be used as input for the contextual documentation, making sure "Codebase" is selected, and then click “Generate New Doc”
82+
83+
<br></br>
84+
85+
![step_16.png](/img/use_dev-docs_with_continue/step_16.png)
86+
87+
<br></br>
88+
89+
When you navigate back to the file explorer you should see some files populated in dev-docs folder
90+
91+
<br></br>
92+
93+
![step_31.png](/img/use_dev-docs_with_continue/step_31.png)
94+
95+
<br></br>
96+
97+
# **Step 4: Open the Continue extension and sign in**
98+
99+
<br></br>
100+
101+
Click the Continue extension icon in the Activity Bar and sign in with your GitHub account to use the Continue free trial models (or add your own API keys if you’d like instead)
102+
103+
<br></br>
104+
105+
![step_22.png](/img/use_dev-docs_with_continue/step_22.png)
106+
107+
<br></br>
108+
109+
# Step 5: Use @dev-docs as context and ask questions
110+
111+
<br></br>
112+
113+
Continue will automatically allow you to use dev-docs folder as context (using the folder context provider)
114+
115+
<br></br>
116+
117+
![step_24.png](/img/use_dev-docs_with_continue/step_24.png)
118+
119+
<br></br>
120+
121+
Try asking questions like “@dev-docs what technologies are used?“
122+
123+
<br></br>
124+
125+
![step_28.png](/img/use_dev-docs_with_continue/step_28.png)
126+
127+
<br></br>
191 KB
Loading
159 KB
Loading
159 KB
Loading
185 KB
Loading
186 KB
Loading
221 KB
Loading
186 KB
Loading
234 KB
Loading
269 KB
Loading

0 commit comments

Comments
 (0)