From e750c907d9beccfb8387b3a216d24e1ff2f3cb4e Mon Sep 17 00:00:00 2001
From: "dev-docs-github-app-dev[bot]"
 <178211755+dev-docs-github-app-dev[bot]@users.noreply.github.com>
Date: Thu, 16 Jan 2025 01:22:19 +0000
Subject: [PATCH] md file

---
 .../generate docs on custom branches.md       | 42 +++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 docs/github-app/generate docs on custom branches.md

diff --git a/docs/github-app/generate docs on custom branches.md b/docs/github-app/generate docs on custom branches.md
new file mode 100644
index 000000000..33b1062c3
--- /dev/null
+++ b/docs/github-app/generate docs on custom branches.md	
@@ -0,0 +1,42 @@
+
+
+  # How to Customize dev-docs.json for Branch-Specific Documentation
+
+## Overview
+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.
+
+## Steps
+
+1. Locate the dev-docs.json file
+   - File should be in the root of your repository
+
+2. Edit the dev-docs.json file
+   - Add or modify the `gitHubApp` section
+
+3. Specify branches to monitor
+   - Add a `branches` array under `gitHubApp`
+
+4. Configure workflows
+   - Add a `workflows` array under `gitHubApp`
+
+5. Set up changelog location (optional)
+   - Add a `changelog` object under `gitHubApp`
+
+## Code Example
+
+```json
+{
+  "gitHubApp": {
+    "branches": ["main", "develop", "feature"],
+    "workflows": ["generateDocs"]
+  }
+}
+```
+
+## Notes
+
+- The app checks the `branches` array in `dev-docs.json` to determine which pushes to process.
+- If `branches` is not specified, it defaults to the repository's default branch.
+- The `workflows` array determines which documentation generation processes to run.
+
+  
\ No newline at end of file