Updated developer docs: 2025-03-13T20:23:03+0000

Author: rolandstdocs

docs/Enabling automations.md

@@ -36,20 +36,20 @@ The `dev-docs.json` file should be placed in the root directory of your reposito
 
 ## Field Descriptions
 
-  1. `gitHubApp.approvalWorkflow`: When set to `true`, creates an approval issue before generating documentation. This is recommended so your team decides when to actually attempt to generate documentation as your code changes.
-  2. `gitHubApp.userDocsWorkflows`: Specifies which documentation workflows to run:
-    * `"generateUserDocs"`: Automatically generates and updates documentation files
-    * `"generateDocsIssue"`: Creates issues to track documentation changes
-  3. `gitHubApp.issues`: Optional but recommend field that is a boolean that allows the GitHub app to create issues on the project
-  4. `gitHubApp.issueNotifications`: List of GitHub usernames to be notified when documentation-related issues are created.
-  5. `gitHubApp.connectedOrg`: Optional field, if you have multiple orgs can you can set what org is associated to your repo
-  6. `gitHubApp.branches`: Optional field that is an array of branches you specificy the GitHub App to listen, such as or `['branch_a', 'branch_b']` or you can use `['*']` to listen for all branch changes. If omitted the GitHub app will only listen for changes on the default branch.
+1. `gitHubApp.approvalWorkflow`: When set to `true`, creates an approval issue before generating documentation. This is recommended so your team decides when to actually attempt to generate documentation as your code changes.
+2. `gitHubApp.userDocsWorkflows`: Specifies which documentation workflows to run:
+  * `"generateUserDocs"`: Automatically generates and updates documentation files
+  * `"generateDocsIssue"`: Creates issues to track documentation changes
+3. `gitHubApp.issues`: Optional but recommend field that is a boolean that allows the GitHub app to create issues on the project
+4. `gitHubApp.issueNotifications`: List of GitHub usernames to be notified when documentation-related issues are created.
+5. `gitHubApp.connectedOrg`: Optional field, if you have multiple orgs can you can set what org is associated to your repo
+6. `gitHubApp.branches`: Optional field that is an array of branches you specificy the GitHub App to listen, such as or `['branch_a', 'branch_b']` or you can use `['*']` to listen for all branch changes. If omitted the GitHub app will only listen for changes on the default branch.
 
 ## Usage
 
-  1. Make sure you have a docs.dev account, have installed the GitHub App on your docs repo, and the codebase you want to document.
-  2. Create a `dev-docs.json` file in your repository's root directory.
-  3. Configure the fields according to your documentation needs.
-  4. Commit and push the file to your repository.
+1. Make sure you have a docs.dev account, have installed the GitHub App on your docs repo, and the codebase you want to document.
+2. Create a `dev-docs.json` file in your repository's root directory.
+3. Configure the fields according to your documentation needs.
+4. Commit and push the file to your repository.
 
 The system will now use these settings to automatically generate and update documentation based on your code changes.

docs/Quickstart.md

@@ -8,8 +8,8 @@ sidebar_position: 2
 Welcome to Docs.dev! Follow the steps below to get started in ***under 5 minutes***.
 
 ## Prerequisites
-  * A GitHub account for authenticating with [Docs.dev](http://Docs.dev).
-  * A documentation repo in GitHub. If you do not have one, go [here](/docs/editor/connect-the-starter-template-to-the-ai-editor) and follow the guide to set up a new docs repo using our open source Docusaurus template.
+* A GitHub account for authenticating with [Docs.dev](http://Docs.dev).
+* A documentation repo in GitHub. If you do not have one, go [here](/docs/editor/connect-the-starter-template-to-the-ai-editor) and follow the guide to set up a new docs repo using our open source Docusaurus template.
 
 ## Create account
 Go to [app.docs.dev](http://app.docs.dev) and log in with GitHub to create your account and create an org within Docs.dev.

docs/automations.md

@@ -8,8 +8,8 @@ sidebar_position: 4
 
 Prevent documentation drift by automating your docs directly in the GitHub workflow
 
-  * Generate docs from PRs
-  * Get flagged when docs are out of date
-  * and more
+* Generate docs from PRs
+* Get flagged when docs are out of date
+* and more
 
 This feature is in beta. Reach out directly to get set up.

docs/editor/connect-the-starter-template-to-the-ai-editor.md

@@ -19,10 +19,10 @@ On the GitHub page, click on **New repo** to create a new repo for your document
 ## 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)
+* 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.
 

docs/managingcontent/advancedAItools.md

@@ -14,19 +14,19 @@ Refer to the guides below to learn how to learn how you can use AI to help you g
 
 **Audit docs** allows you to have AI scan your existing docs based on any prompt of your choosing. Examples of how to use it include spelling and grammar checks across your docs or making broad sweeping changes across all your docs, such as changing names or links. Follow the steps below to audit your existing docs:
 
-  * Select **AI tools** in the top right hand corner of the web editor and navigate to **Audit docs** in the drop down menu.
-  * Select which docs or folders you would like to check against. If you would like for the AI to also check your docs against your codebase, you can select the checkbox. Selecting this will bring the codebases you have connected to the GitHub App into the same drop down menu.
-  * Add any prompt you choose into the **Describe what you want to audit field**.
-  * Select **Submit** once you have your prompt ready and let the AI go to work.
+* Select **AI tools** in the top right hand corner of the web editor and navigate to **Audit docs** in the drop down menu.
+* Select which docs or folders you would like to check against. If you would like for the AI to also check your docs against your codebase, you can select the checkbox. Selecting this will bring the codebases you have connected to the GitHub App into the same drop down menu.
+* Add any prompt you choose into the **Describe what you want to audit field**.
+* Select **Submit** once you have your prompt ready and let the AI go to work.
 
 When complete, you will see a table of suggested changes when finished. Select which docs you would like it automatically generate. Everything generated here will go back into the web editor so you can edit as you see fit and then push to the GitHub branch of your choosing when ready.
 
 ## Analyze docs
 
 The **Analyze docs** feature allows you to analyze the quality of your existing documentation as a whole. Note that this doesn't check against individual docs but instead your entire docs repo. Follow the steps below to analyze your existing docs:
 
-  * Select **AI tools** in the top right hand corner of the web editor and navigate to **Analyze docs** in the drop down menu.
-  * Once selected the AI will go to work and will start to analyze your docs.
+* Select **AI tools** in the top right hand corner of the web editor and navigate to **Analyze docs** in the drop down menu.
+* Once selected the AI will go to work and will start to analyze your docs.
 
 When finished you'll see a list of personas that have grades against them. These are the personas that the AI believes your docs are intended to be positioned towards, as well as a grade for how effective they are at speaking to that persona. Below you'll see the AI suggest some docs that it believes will be helpful to add to your docs site to improve the effectiveness for a given persona. Select which files you'd like to generate and let the AI create some drafts for you.
 
@@ -36,21 +36,20 @@ Everything generated here will go back into the web editor so you can edit as yo
 
 The **Generate content** feature allows you to generate new docs from your existing documentation and other connected codebases. Follow the steps below to generate a new doc:
 
-  * Select **AI tools** in the top right hand corner of the web editor and navigate to **Generate content** in the drop down menu.
-  * Select which docs you would like to use as context.
-  * (Optional) You can also check the checkbox to use your other connected codebases as context.
-  * Once you have all your context selected, insert your prompt into the text field and hit submit to get a new doc page.
+* Select **AI tools** in the top right hand corner of the web editor and navigate to **Generate content** in the drop down menu.
+* Select which docs you would like to use as context.
+* (Optional) You can also check the checkbox to use your other connected codebases as context.
+* Once you have all your context selected, insert your prompt into the text field and hit submit to get a new doc page.
 
 Everything generated here will go back into the web editor so you can edit as you see fit and then push to the GitHub branch of your choosing when ready.
 
 ## Generate docs from code objects
 
 This feature allows you to generate net new docs from code objects in your codebase or SDK. The AI will search your selected codebase for relevant code objects and recommend which it believes should have docs on them. Follow the steps below to generate docs from code objects:
-
-  * Select the **AI tools** drop down in the top right hand corner of the web editor and select **Code objects** in the drop down menu.
-  * Go through the drop down menus to select which code files the code objects are defined in and then which files have relevant context (if any) for those code objects.
-  * Enter in which types of objects you would like the AI to search for and suggest docs for.
-  * Select **Submit** and the AI will go into the selected codebase(s) to find the relevant objects it believes will be helpful to document.
+* Select the **AI tools** drop down in the top right hand corner of the web editor and select **Code objects** in the drop down menu.
+* Go through the drop down menus to select which code files the code objects are defined in and then which files have relevant context (if any) for those code objects.
+* Enter in which types of objects you would like the AI to search for and suggest docs for.
+* Select **Submit** and the AI will go into the selected codebase(s) to find the relevant objects it believes will be helpful to document.
 
 When finished, you will see a table of suggested docs where you can select which docs you would like to generate. Everything generated here will go back into the web editor so you can edit as you see fit and then push to GitHub when ready.
 
@@ -60,7 +59,7 @@ Note: the files in the drop down menus are from the codebases you connected to o
 
 The Generate complete docs feature is meant for those without any existing documentation footprint. Using this feature will have the AI scan your selected codebase and suggest multiple documentation pages that it believes will help a user leverage your product. You can then select which pages you want it to create. Follow the steps below to generate a set of new docs directly from your codebase:
 
-  * Select **AI tools** in the top right hand corner of the web editor and navigate to **Generate complete docs** in the drop down menu.
-  * Select which codebase you would like to generate docs for and then select **Generate documentation**.
+* Select **AI tools** in the top right hand corner of the web editor and navigate to **Generate complete docs** in the drop down menu.
+* Select which codebase you would like to generate docs for and then select **Generate documentation**.
 
 Watch the AI go to work and generate a new set of docs for your project. Once generated, everything generated will go back into the web editor so you can edit as you see fit and then push to the GitHub branch of your choosing when ready.

docs/managingcontent/webeditor.md

@@ -26,12 +26,12 @@ Highlight any text and select **AI tools **to have AI assist your writ
 ### Drop down menu
 Highlight any text, select the `+` button, or type `/` to view a drop down menu where you can:
 
-  * Format headings
-  * Create bulleted and numbered lists
-  * Insert a code block
-  * Add and image
-  * Add a table
-  * Ask Docs.dev AI for assistance
+* Format headings
+* Create bulleted and numbered lists
+* Insert a code block
+* Add and image
+* Add a table
+* Ask Docs.dev AI for assistance
 
 ### Add and edit frontmatter
 Select the information button on the top right of web editor to add or edit frontmatter.