Skip to content

Commit df96444

Browse files
md file
1 parent d970b7a commit df96444

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 file describes a Visual Studio Code extension command called "devdocs.auditDocs" that automates the process of auditing and improving documentation in a project. The command uses AI to analyze markdown files in a project's docs directory, suggesting improvements for grammar, spelling, clarity, and aesthetics. It generates an "_audit.md" file with suggestions and creates GitHub issues for each analyzed file.
7+
8+
Key features of the command include:
9+
1. Analyzing all markdown files in the docs directory
10+
2. Using AI to generate improvement suggestions
11+
3. Creating a comprehensive audit report
12+
4. Generating GitHub issues for each file
13+
5. Customizable audit tasks via dev-docs.json configuration
14+
15+
The file also explains why this command is useful, how to use it, and what configuration options are available in the dev-docs.json file. It emphasizes the benefits of maintaining high-quality documentation and how this automated process can save time and effort for developers and technical writers.
16+
17+

0 commit comments

Comments
 (0)