Skip to main content

Contextual Documentation with Dev-Docs and Continue

· One min read
Andrew Van Beek
Dev-Docs CEO and Co-Founder

Contextual Documentation with Dev-Docs and Continue

Andrew Van Beek,  Est Reading Time: 4 min

Andrew Van Beek

Continue 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!


Dev-Docs 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.

Before you get started

Install Dev-Docs in VS Code


step_3.png


Install Continue in VS Code


step_6.png


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"


image.png


Once you are signed in, you will need to create an org name for your team. For example, our org name here is "continuedev"


step_11.png


Step 2: Set up your repository and generate context

Click the "Setup my repo" button and then the "Generate Context" button


step_7.png


This will create a dev-docs.json file and dev-docs folder in your repo


step_14.png


Select the "Generate Context" button


step_15.png


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"


step_16.png


When you navigate back to the file explorer you should see some files populated in dev-docs folder


step_31.png


Step 4: Open the Continue extension and sign in


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)


step_22.png


Step 5: Use @dev-docs as context and ask questions


Continue will automatically allow you to use dev-docs folder as context (using the folder context provider)


step_24.png


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


step_28.png


Conclusion


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. Everything from code explaination, high level context, best practices, and architecture are now super charged with Continue and Dev-Docs. Thanks for reading!

Dev-Docs AI Bot

Circular button