Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions Enable generating codebase docs for the GitHub App.md
Original file line number Diff line number Diff line change
@@ -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.