Skip to content

Commit 14d9711

Browse files
Update file
1 parent 1077c3a commit 14d9711

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

docs/Enabling automations.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ The `dev-docs.json` file should be placed in the root directory of your reposito
1717
### Required Fields
1818

1919
* `gitHubApp`: Object containing GitHub-related configurations
20+
2021
* `approvalWorkflow`: Boolean, enables or disables the approval workflow
22+
2123
* `userDocsWorkflows`: Array of strings, specifies which documentation workflows to run
24+
2225
* `issueNotifications`: Array of strings, GitHub usernames to notify on issue creation
2326

2427
## Example Configuration
@@ -37,19 +40,29 @@ The `dev-docs.json` file should be placed in the root directory of your reposito
3740
## Field Descriptions
3841

3942
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.
43+
4044
2. `gitHubApp.userDocsWorkflows`: Specifies which documentation workflows to run:
41-
* `"generateUserDocs"`: Automatically generates and updates documentation files
42-
* `"generateDocsIssue"`: Creates issues to track documentation changes
45+
46+
* `"generateUserDocs"`: Automatically generates and updates documentation files
47+
48+
* `"generateDocsIssue"`: Creates issues to track documentation changes
49+
4350
3. `gitHubApp.issues`: Optional but recommend field that is a boolean that allows the GitHub app to create issues on the project
51+
4452
4. `gitHubApp.issueNotifications`: List of GitHub usernames to be notified when documentation-related issues are created.
53+
4554
5. `gitHubApp.connectedOrg`: Optional field, if you have multiple orgs can you can set what org is associated to your repo
55+
4656
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.
4757

4858
## Usage
4959

5060
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.
61+
5162
2. Create a `dev-docs.json` file in your repository's root directory.
63+
5264
3. Configure the fields according to your documentation needs.
65+
5366
4. Commit and push the file to your repository.
5467

5568
The system will now use these settings to automatically generate and update documentation based on your code changes.

0 commit comments

Comments
 (0)