You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*`approvalWorkflow`: Boolean, enables or disables the approval workflow
22
+
21
23
*`userDocsWorkflows`: Array of strings, specifies which documentation workflows to run
24
+
22
25
*`issueNotifications`: Array of strings, GitHub usernames to notify on issue creation
23
26
24
27
## Example Configuration
@@ -37,19 +40,29 @@ The `dev-docs.json` file should be placed in the root directory of your reposito
37
40
## Field Descriptions
38
41
39
42
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
+
40
44
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
+
43
50
3.`gitHubApp.issues`: Optional but recommend field that is a boolean that allows the GitHub app to create issues on the project
51
+
44
52
4.`gitHubApp.issueNotifications`: List of GitHub usernames to be notified when documentation-related issues are created.
53
+
45
54
5.`gitHubApp.connectedOrg`: Optional field, if you have multiple orgs can you can set what org is associated to your repo
55
+
46
56
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.
47
57
48
58
## Usage
49
59
50
60
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
+
51
62
2. Create a `dev-docs.json` file in your repository's root directory.
63
+
52
64
3. Configure the fields according to your documentation needs.
65
+
53
66
4. Commit and push the file to your repository.
54
67
55
68
The system will now use these settings to automatically generate and update documentation based on your code changes.
0 commit comments