Skip to content

Commit e750c90

Browse files
md file
1 parent b2ea110 commit e750c90

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
3+
# How to Customize dev-docs.json for Branch-Specific Documentation
4+
5+
## Overview
6+
This guide explains how to modify the `dev-docs.json` file to configure the GitHub app to listen for pushes on specific branches and generate documentation in the `dev-docs` folder.
7+
8+
## Steps
9+
10+
1. Locate the dev-docs.json file
11+
- File should be in the root of your repository
12+
13+
2. Edit the dev-docs.json file
14+
- Add or modify the `gitHubApp` section
15+
16+
3. Specify branches to monitor
17+
- Add a `branches` array under `gitHubApp`
18+
19+
4. Configure workflows
20+
- Add a `workflows` array under `gitHubApp`
21+
22+
5. Set up changelog location (optional)
23+
- Add a `changelog` object under `gitHubApp`
24+
25+
## Code Example
26+
27+
```json
28+
{
29+
"gitHubApp": {
30+
"branches": ["main", "develop", "feature"],
31+
"workflows": ["generateDocs"]
32+
}
33+
}
34+
```
35+
36+
## Notes
37+
38+
- The app checks the `branches` array in `dev-docs.json` to determine which pushes to process.
39+
- If `branches` is not specified, it defaults to the repository's default branch.
40+
- The `workflows` array determines which documentation generation processes to run.
41+
42+

0 commit comments

Comments
 (0)