You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# **Contextual documentation with Dev-Docs and Continue**
10
12
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!
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!
12
14
13
15
<br></br>
14
16
@@ -34,23 +36,25 @@ Install Continue in VS Code
34
36
35
37
# **Step 1: Open the Dev-Docs extension and sign in**
36
38
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"
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
54
58
55
59
<br></br>
56
60
@@ -74,11 +78,11 @@ Select the "Generate Context" button
74
78
75
79
<br></br>
76
80
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**
78
82
79
83
<br></br>
80
84
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"
82
86
83
87
<br></br>
84
88
@@ -98,7 +102,7 @@ When you navigate back to the file explorer you should see some files populated
98
102
99
103
<br></br>
100
104
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)
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)
102
106
103
107
<br></br>
104
108
@@ -118,10 +122,28 @@ Continue will automatically allow you to use dev-docs folder as context (using t
118
122
119
123
<br></br>
120
124
121
-
Try asking questions like “@dev-docs what technologies are used?“
125
+
Try asking questions like "@dev-docs what technologies are used?"
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.
0 commit comments