Skip to content

Commit 0fdb64b

Browse files
md file
1 parent 8c24039 commit 0fdb64b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
3+
---
4+
# High Level Context
5+
## context
6+
This markdown file describes a VS Code extension command called "Generate High Level Context for the Folder". The command analyzes all code files within a selected folder and generates a comprehensive summary of the folder's purpose and functionality. Key points include:
7+
8+
1. The command's purpose is to provide a high-level overview of a folder's contents without examining individual files.
9+
2. It's useful for large codebases, onboarding new team members, code reviews, and documenting project architecture.
10+
3. The file details relevant configuration options in the `dev-docs.json` file, including `ai.contextDirs`, `ai.internalTypeFilters`, `customRoot`, and `workspaceRoot`.
11+
4. It provides an example JSON configuration for the relevant options.
12+
5. The file outlines prerequisites for using the command, including a valid `dev-docs.json` file and proper folder location.
13+
6. Instructions for using the command are provided, both through the Explorer view context menu and the Command Palette.
14+
7. The generated high-level context document aims to improve understanding of code structure and organization within the selected folder.
15+
16+

0 commit comments

Comments
 (0)