|
1 | | - |
2 | | - |
3 | | - --- |
| 1 | +--- |
4 | 2 | title: Contextual documentation with Dev-Docs and Continue |
5 | 3 | authors: andrew |
6 | 4 | header_image: /img/dev-docs-assets/ClippedHeroBg.png |
@@ -130,19 +128,22 @@ Try asking questions like "@dev-docs what technologies are used?" |
130 | 128 |
|
131 | 129 | <br></br> |
132 | 130 |
|
133 | | -# Step 6: Leveraging Dev-Docs context in Continue |
| 131 | +# Conclusion |
| 132 | + |
| 133 | + |
| 134 | +<br></br> |
134 | 135 |
|
135 | 136 | 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 |
|
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 | +- **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 |
|
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 | +- **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 |
|
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 | +- **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 |
|
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 | +- **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 |
|
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 | +- **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 |
|
147 | 148 | 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