Skip to main content

Connect the starter template to the AI editor

Step 1: Navigate to the Dev-Docs dashboard​

Dev-Docs dashboard

Navigate to the Dev-Docs dashboard, and to the left click "User-facing docs"

Step 2: Generate Starter template docs​

Click setup and then in the dialog select "use our template" to generate your own starter docs repository for Dev-Docs to connect to.

Step 3: Create a new repository​

Create new repository

On the GitHub page, click on "New repository" to create a new repository for your documentation.

Step 4: Set up the repository​

Set up repository

Fill in the repository details:

  • Choose the repository template (e.g., team-dev-docs/starter-template-v3)

  • Set the owner

  • Name your repository (e.g., my_cool_new_docs)

  • Choose visibility (public or private)

Click "Create repository" when done.

Step 5: View the new repository​

View new repository

Your new repository is now created with the initial commit and files from the template.

Step 6: Return back to Dev-Docs to connect your new docs​

Set up docs

Back in Dev-Docs, you'll see a prompt to set up your docs. Click "Connect your own docs" to proceed.

Step 7: Set up User-Facing Docs​

Set up User-Facing Docs

Click on "install the GitHub App".

Step 8: Confirm repository selection​

Click "install" or "Configure" if you have installed already.

Step 9: Select your account or org​

Select your GitHub account you want to install it on

Step 10: Add the docs repo​

From the dropdown you should see the docs repo we created in the prior steps. Be sure to select it and click "save".

Step 11: Associate your repo with your Dev-Docs org​

Check to make sure your repo name matches your desired Dev-Docs org and click "complete GitHub App Setup"

Step 12: Set your documentation repo​

You should now see a dialog that tells you to select your documentation repo. Make sure to select the one we set up from the dropdown. This is basically telling Dev-Docs this is where my docs will live, and therefore is the location the Dev-Docs editor should connect to.

Step 13: Open the editor on your new docs​

Step 14: Push changes to GitHub​

Push to GitHubYou'll now have access to the AI editor interface where you can start creating and editing your documentation.

Dev-Docs AI Bot

Circular button