Skip to content

Commit 62a2206

Browse files
md file
1 parent 339916c commit 62a2206

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 Markdown file describes a Visual Studio Code extension command called "Generate an External Doc Page" (devdocs.createExternalDoc). The command is designed to automatically generate external documentation for code projects. Key points include:
7+
8+
1. Purpose: To create standalone documentation pages that can be hosted separately from the codebase.
9+
10+
2. Functionality: It analyzes code, extracts information, and generates a Markdown file containing documentation.
11+
12+
3. Benefits: Separates documentation from code, improves accessibility and discoverability, and allows for customization.
13+
14+
4. Configuration: Uses a dev-docs.json file to set options like output path, Git branch, templates, and content filters.
15+
16+
5. Usage: Can be triggered via keyboard shortcut, command palette, or context menu in VS Code.
17+
18+
6. Prerequisites: Requires GitHub authentication, Git repository, and proper configuration.
19+
20+
The file provides a comprehensive overview of the command's purpose, configuration options, prerequisites, and step-by-step usage instructions, making it a valuable resource for developers using this VS Code extension feature.
21+
22+

0 commit comments

Comments
 (0)