From 9eb036b71cda19ae259abcfef15d94c93b42e0c3 Mon Sep 17 00:00:00 2001
From: avb-is-me <104213687+avb-is-me@users.noreply.github.com>
Date: Tue, 22 Oct 2024 13:03:28 -0700
Subject: [PATCH] md file

---
 ...rating codebase docs for the GitHub App.md | 61 +++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 Enable generating codebase docs for the GitHub App.md

diff --git a/Enable generating codebase docs for the GitHub App.md b/Enable generating codebase docs for the GitHub App.md
new file mode 100644
index 000000000..14ab1ecde
--- /dev/null
+++ b/Enable generating codebase docs for the GitHub App.md	
@@ -0,0 +1,61 @@
+
+
+  # Configuring dev-docs.json for GitHub App Documentation Generation
+
+This guide will walk you through the process of configuring the `dev-docs.json` file to enable automatic documentation generation using the Dev-Docs GitHub App.
+
+## Step 1: Locate the dev-docs.json file
+
+The `dev-docs.json` file should be located in the root directory of your repository.
+
+## Step 2: Basic Structure
+
+Ensure your `dev-docs.json` file has the following basic structure:
+
+```json
+{
+  "gitHubApp": {
+    "workflows": []
+  }
+}
+```
+
+## Step 3: Configure Workflows
+
+To enable documentation generation, add the `generateDocs` workflow to the `workflows` array:
+
+```json
+{
+  "gitHubApp": {
+    "workflows": ["generateDocs"]
+  }
+}
+```
+
+Note: The `workflows` array accepts specific enum values. Currently, the supported values are:
+
+- `generateDocs`: Enables automatic documentation generation
+- `generateChangelog`: Enables automatic changelog generation
+
+## Step 4: Additional Configuration (Optional)
+
+Depending on your project's needs, you may want to add more configuration options. For example:
+
+```json
+{
+  "ai":{
+    "contextDirs": ["src", "lib"],
+  },
+  "gitHubApp": {
+    "workflows": ["generateDocs"]
+  }
+}
+```
+
+## Step 5: Commit and Push
+
+After configuring your `dev-docs.json` and installing the GitHub app, commit the changes and push them to your repository.
+
+
+
+  
\ No newline at end of file