Skip to main content

Create new docs repo

Step 1: Begin setup​

When first setting up your Docs.dev account you will be prompted to set up your docs. If you don't have a documentation repo and you would like use our starter template, select Don't have docs to connect? Use our GitHub docs template. Clicking this will take you out of Docs.dev and into your GitHub where you can install and set up the Dev-Docs GitHub App.

Generate Starter Template

Step 3: Create a new repo on GitHub​

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

Create new repository

Step 4: Set up the repo details​

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.

Set up repository

Step 5: View the newly created repo​

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

View new repository

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

Once the new repo is set up, go back to the Docs.dev web app and confirm that your repo name matches your desired Docs.dev organization and select Connect your own docs to proceed.

Set up docs

Step 7: Set up User-Facing Docs by installing GitHub App​

Select Connect your own docs and click on Install the GitHub App to begin the integration process. Clicking this will take you out of Docs.dev and into your GitHub where you can install and set up the Dev-Docs GitHub App.

Set up User-Facing Docs

Step 8: Confirm repo selection for GitHub App​

Select Install or Configure if you have installed the app already.

Confirm repository selection

Step 9: Select your GitHub account or organization​

Choose the GitHub account or organization where you want to install the app.

Select GitHub account

Step 10: Add the documentation repo​

From the dropdown, find your newly created docs repo. Feel free to connect any other public codebases you would like the app to have access to as context. Be sure to select it and select Save.

Add docs repo

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

Once done, go back to the Docs.dev web app and confirm that your repo name matches your desired Docs.dev organization and select Complete GitHub App Setup.

Associate repo with Dev-Docs org

Step 12: Set your documentation repo in Dev-Docs​

You should now see a dialog prompting you to select your documentation repo. Choose the one we set up from the dropdown. This step informs Docs.dev where your documentation lives and where the Docs.dev editor should pull from. Once this step is done you're all set and ready to go!

Dev-Docs AI Bot

Circular button