Skip to content

Commit e9a0544

Browse files
md file
1 parent 8f7ffc1 commit e9a0544

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

dev-docs/context-docs-VS Code Commands-Auditing-Documentation-Using-the-devdocs.auditdocs-Command.md.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,19 @@ This Markdown file provides documentation for the "Audit Docs" command in a VS C
1414

1515
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.
1616

17+
---
18+
# Example JSON of relevant Dev-Docs.json options docs/VS Code Commands/Auditing-Documentation-Using-the-devdocs.auditdocs-Command.md
19+
## Imported Code Object
20+
This JSON snippet represents a configuration for AI-related tasks, specifically focusing on document auditing. Here's a concise explanation:
21+
22+
1. The `ai` object contains settings related to AI functionality.
23+
24+
2. Within `ai`, there's an `auditTasks` array that lists specific tasks for the AI to perform during a document audit.
25+
26+
3. The two tasks listed are:
27+
- Checking sections where code blocks might result in errors
28+
- Ensuring consistent formatting and styling throughout the document
29+
30+
This configuration would likely be used to guide an AI system in performing automated quality checks on technical documentation or code samples.
31+
1732

0 commit comments

Comments
 (0)