diff --git a/blog/Use Dev-Docs with Continue.md b/blog/Use Dev-Docs with Continue.md index 35672d573..44c5f9b85 100644 --- a/blog/Use Dev-Docs with Continue.md +++ b/blog/Use Dev-Docs with Continue.md @@ -1,14 +1,16 @@ ---- + + + --- title: Contextual documentation with Dev-Docs and Continue authors: andrew header_image: /img/dev-docs-assets/ClippedHeroBg.png text_color: white -tags: [docs, seo, sales] +tags: [docs, seo, sales, ai, code-assistant] --- # **Contextual documentation with Dev-Docs and Continue** -[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! +[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!

@@ -34,7 +36,7 @@ Install Continue in VS Code # **Step 1: Open the Dev-Docs extension and sign in** -Select the “Dev-Docs” extension icon from the Activity Bar on the left and then “Sign In” +Select the "Dev-Docs" extension icon from the Activity Bar on the left and then "Sign In"

@@ -42,7 +44,7 @@ Select the “Dev-Docs” extension icon from the Activity Bar on the left and t

-Once you are signed in, you will need to create an org name for your team. For example, our org name here is “devdocscontinueblog” +Once you are signed in, you will need to create an org name for your team. For example, our org name here is "devdocscontinueblog"

@@ -50,7 +52,9 @@ Once you are signed in, you will need to create an org name for your team. For

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

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

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

-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” +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"

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

-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) +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)

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

-Try asking questions like “@dev-docs what technologies are used?“ +Try asking questions like "@dev-docs what technologies are used?"

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

\ No newline at end of file +

+ +# Step 6: Leveraging Dev-Docs context in Continue + +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: + +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". + +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". + +3. **Dependency insights**: Inquire about the libraries and frameworks used in your project. For instance, "@dev-docs list the main dependencies and their versions". + +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?". + +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?". + +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. + + \ No newline at end of file