Skip to content

Commit a23cdc3

Browse files
authored
Merge pull request #281 from team-dev-docs/dev-docs-Dev-Docs_Update_2024-11-18_14-13-52
Dev-Docs Update
2 parents 9e22210 + 0245e34 commit a23cdc3

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

blog/Use Dev-Docs with Continue.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
---
1+
2+
3+
---
24
title: Contextual documentation with Dev-Docs and Continue
35
authors: andrew
46
header_image: /img/dev-docs-assets/ClippedHeroBg.png
57
text_color: white
6-
tags: [docs, seo, sales]
8+
tags: [docs, seo, sales, ai, code-assistant]
79
---
810

911
# **Contextual documentation with Dev-Docs and Continue**
1012

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. Whats even more awesome is that it is extensible—for example, you can use any models you want with it!
13+
[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!
1214

1315
<br></br>
1416

@@ -34,23 +36,25 @@ Install Continue in VS Code
3436

3537
# **Step 1: Open the Dev-Docs extension and sign in**
3638

37-
Select the Dev-Docs extension icon from the Activity Bar on the left and then Sign In
39+
Select the "Dev-Docs" extension icon from the Activity Bar on the left and then "Sign In"
3840

3941
<br></br>
4042

4143
![image.png](/img/use_dev-docs_with_continue/step_8.png)
4244

4345
<br></br>
4446

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
47+
Once you are signed in, you will need to create an org name for your team. For example, our org name here is "devdocscontinueblog"
4648

4749
<br></br>
4850

4951
![step_11.png](/img/use_dev-docs_with_continue/step_11.png)
5052

5153
<br></br>
5254

53-
Step 2: Click the “Setup my repo” button and then the “Generate Context” button
55+
# **Step 2: Set up your repository and generate context**
56+
57+
Click the "Setup my repo" button and then the "Generate Context" button
5458

5559
<br></br>
5660

@@ -74,11 +78,11 @@ Select the "Generate Context" button
7478

7579
<br></br>
7680

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)**
81+
# **Step 3: Select files and generate contextual documentation**
7882

7983
<br></br>
8084

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
85+
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"
8286

8387
<br></br>
8488

@@ -98,7 +102,7 @@ When you navigate back to the file explorer you should see some files populated
98102

99103
<br></br>
100104

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 youd like instead)
105+
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)
102106

103107
<br></br>
104108

@@ -118,10 +122,28 @@ Continue will automatically allow you to use dev-docs folder as context (using t
118122

119123
<br></br>
120124

121-
Try asking questions like @dev-docs what technologies are used?
125+
Try asking questions like "@dev-docs what technologies are used?"
122126

123127
<br></br>
124128

125129
![step_28.png](/img/use_dev-docs_with_continue/step_28.png)
126130

127-
<br></br>
131+
<br></br>
132+
133+
# Step 6: Leveraging Dev-Docs context in Continue
134+
135+
Now that you have set up both Dev-Docs and Continue, you can take full advantage of the contextual documentation generated by Dev-Docs within Continue. Here are some additional ways to utilize this powerful combination:
136+
137+
1. **Code explanations**: Ask Continue to explain specific parts of your codebase using the Dev-Docs context. For example, "@dev-docs explain the purpose of the main function in app.js".
138+
139+
2. **Architecture overview**: Use the generated documentation to get a high-level understanding of your project structure. Try asking "@dev-docs summarize the overall architecture of this project".
140+
141+
3. **Dependency insights**: Inquire about the libraries and frameworks used in your project. For instance, "@dev-docs list the main dependencies and their versions".
142+
143+
4. **Best practices**: Leverage the contextual documentation to ensure you're following project-specific conventions. Ask questions like "@dev-docs what are the coding standards for this project?".
144+
145+
5. **Troubleshooting**: When facing issues, use the Dev-Docs context to help identify potential problems. For example, "@dev-docs are there any known issues or limitations with the current implementation?".
146+
147+
By combining the power of Dev-Docs' contextual documentation with Continue's AI-driven code assistance, you can significantly enhance your development workflow and maintain a deeper understanding of your codebase.
148+
149+

0 commit comments

Comments
 (0)