From 48ded27c3684f4b3e97f331695b2d8a1de8e794b Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 15:59:21 +0000 Subject: [PATCH 1/7] Update file --- docs/automations.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/automations.md b/docs/automations.md index 6f60ce141..7839ac185 100644 --- a/docs/automations.md +++ b/docs/automations.md @@ -2,11 +2,16 @@ sidebar_position: 4 --- + + # Automate the process in GitHub (beta) + 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 This feature is in beta. Reach out directly to get set up. From 2d269549bc7d36461d819f760a8401e06c69a9c9 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:00:14 +0000 Subject: [PATCH 2/7] Update file --- docs/Enabling automations.md | 44 ++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/docs/Enabling automations.md b/docs/Enabling automations.md index bdd28ee08..6d60acb6d 100644 --- a/docs/Enabling automations.md +++ b/docs/Enabling automations.md @@ -1,6 +1,10 @@ +--- +sidebar_position: 5 +--- - # Configuring dev-docs.json for Automatic Documentation Generation + +# Configuring dev-docs.json for Automatic Documentation Generation This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes. @@ -12,10 +16,13 @@ The `dev-docs.json` file should be placed in the root directory of your reposito ### Required Fields -- `gitHubApp`: Object containing GitHub-related configurations - - `approvalWorkflow`: Boolean, enables or disables the approval workflow - - `userDocsWorkflows`: Array of strings, specifies which documentation workflows to run - - `issueNotifications`: Array of strings, GitHub usernames to notify on issue creation +* `gitHubApp`: Object containing GitHub-related configurations + + * `approvalWorkflow`: Boolean, enables or disables the approval workflow + + * `userDocsWorkflows`: Array of strings, specifies which documentation workflows to run + + * `issueNotifications`: Array of strings, GitHub usernames to notify on issue creation ## Example Configuration @@ -32,23 +39,30 @@ 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. +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 + + * `"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. + +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. -1. Create a `dev-docs.json` file in your repository's root directory. -2. Configure the fields according to your documentation needs. -3. 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. +2. Create a `dev-docs.json` file in your repository's root directory. - \ No newline at end of file +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. From 9d11df183d0128cbabcff80ab7308257a44901e3 Mon Sep 17 00:00:00 2001 From: avb-dev-docs <123575048+avb-dev-docs@users.noreply.github.com> Date: Thu, 13 Mar 2025 09:00:37 -0700 Subject: [PATCH 3/7] Update _category_.json --- docs/editor/_category_.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/editor/_category_.json b/docs/editor/_category_.json index e1ce1d5cf..347ad3b9a 100644 --- a/docs/editor/_category_.json +++ b/docs/editor/_category_.json @@ -1,4 +1,4 @@ { - "position": 5, + "position": 6, "label": "Guides" } From b78617dbbfa67aa9eb3e8447529e0f86bb3db342 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:02:29 +0000 Subject: [PATCH 4/7] Update file --- docs/Enabling automations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Enabling automations.md b/docs/Enabling automations.md index 6d60acb6d..8b6641b00 100644 --- a/docs/Enabling automations.md +++ b/docs/Enabling automations.md @@ -4,7 +4,7 @@ sidebar_position: 5 -# Configuring dev-docs.json for Automatic Documentation Generation +# Configuring automatic This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes. From 4269681fabdb3610ec64dc086055652139474f47 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:02:36 +0000 Subject: [PATCH 5/7] Update file --- docs/Enabling automations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Enabling automations.md b/docs/Enabling automations.md index 8b6641b00..8d56d37fc 100644 --- a/docs/Enabling automations.md +++ b/docs/Enabling automations.md @@ -4,7 +4,7 @@ sidebar_position: 5 -# Configuring automatic +# Configuring doc autopilot This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes. From af1e777883c6e896f3902f952d71ada7d35aacf3 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:02:44 +0000 Subject: [PATCH 6/7] Update file --- docs/Enabling automations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Enabling automations.md b/docs/Enabling automations.md index 8d56d37fc..c51ad34a8 100644 --- a/docs/Enabling automations.md +++ b/docs/Enabling automations.md @@ -4,7 +4,7 @@ sidebar_position: 5 -# Configuring doc autopilot +# Configuring doc automation This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes. From efdfaa74eab85be184417990070858b1ae6611d0 Mon Sep 17 00:00:00 2001 From: "dev-docs-github-app[bot]" <178952281+dev-docs-github-app[bot]@users.noreply.github.com> Date: Thu, 13 Mar 2025 16:02:47 +0000 Subject: [PATCH 7/7] Update file --- docs/Enabling automations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Enabling automations.md b/docs/Enabling automations.md index c51ad34a8..859fb551e 100644 --- a/docs/Enabling automations.md +++ b/docs/Enabling automations.md @@ -4,7 +4,7 @@ sidebar_position: 5 -# Configuring doc automation +# Configuring code to doc automation This guide explains how to configure the `dev-docs.json` file with the GitHub app to enable automatic documentation modification and generation when your code changes.