Skip to content

Commit 880ee22

Browse files
md file
1 parent 2e868f3 commit 880ee22

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This file provides a comprehensive overview of the Dev-Docs VS Code Extension, a tool designed to streamline the process of creating and managing documentation for codebases. The document covers:
7+
8+
1. The extension's main features, including automatic documentation generation, outline and context generation, external documentation management, AI-assisted editing, and version control integration.
9+
10+
2. The benefits of using the extension, emphasizing time-saving and improved documentation quality through AI-powered assistance.
11+
12+
3. Key configuration options in the `dev-docs.json` file, which controls the extension's behavior.
13+
14+
4. Prerequisites for using the extension.
15+
16+
5. Instructions on how to use the extension within VS Code, including various methods to access its functionality.
17+
18+
6. An explanation of how the extension works to generate and manage documentation, leveraging AI technologies to keep documentation synchronized with the codebase.
19+
20+
Overall, this document serves as a user guide and reference for developers looking to improve their documentation workflow using the Dev-Docs VS Code Extension.
21+
22+

0 commit comments

Comments
 (0)