Skip to content

Commit 8f7ffc1

Browse files
md file
1 parent d5277c2 commit 8f7ffc1

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 documentation for the "Audit Docs" command in a VS Code extension called Dev-Docs. The command, `devdocs.auditDocs`, is used to analyze and improve the quality of existing documentation in a project. The file explains:
7+
8+
1. The purpose of the command: to audit Markdown files for issues like grammar, spelling, clarity, and visual appeal.
9+
2. Why it's useful: to maintain high-quality, accurate, and clear documentation.
10+
3. Relevant configuration options in the `dev-docs.json` file, including custom audit tasks.
11+
4. Prerequisites for using the command.
12+
5. Step-by-step instructions on how to use the command within VS Code.
13+
6. The output of the command: a generated `dev-docs_audit.md` file with audit results and potential GitHub issues for identified problems.
14+
15+
The document serves as a guide for developers to understand and effectively use the audit functionality provided by the Dev-Docs extension to improve their project documentation.
16+
17+

0 commit comments

Comments
 (0)