Skip to content

Commit 8ecda00

Browse files
Merge pull request #338 from team-dev-docs/Dev-Docs_Update
Dev-Docs Update Dev-Docs update
1 parent 0bfbaa8 commit 8ecda00

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This Markdown file provides instructions for configuring automatic documentation generation using the dev-docs.json file in conjunction with a GitHub app. It explains:
7+
8+
1. Where to place the dev-docs.json file
9+
2. The required and optional configuration fields
10+
3. An example configuration
11+
4. Detailed descriptions of each configuration option
12+
5. The purpose of each setting, such as enabling approval workflows, specifying documentation workflows to run, and setting up issue notifications
13+
6. Steps for implementing the configuration
14+
15+
The file serves as a guide for developers to set up and customize automated documentation processes for their projects, integrating with GitHub for seamless updates and issue tracking.
16+
17+

0 commit comments

Comments
 (0)