Skip to content

Commit 3444547

Browse files
md file
1 parent 1a71998 commit 3444547

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 file describes a Visual Studio Code extension command called "Populate Your External Docs" that automates the generation of API documentation from code. The command analyzes the codebase, identifies relevant symbols (methods, classes, functions), and generates detailed documentation pages for each symbol. These pages are then published to an external location.
7+
8+
Key features of this command include:
9+
1. Configurable through a `dev-docs.json` file
10+
2. Filters for symbol types, code snippets, and symbol names
11+
3. Customizable documentation template
12+
4. Ability to specify the output location within a documentation site
13+
14+
The file explains the purpose of the command, its benefits, configuration options, prerequisites, and step-by-step instructions on how to use it. It emphasizes the importance of maintaining up-to-date documentation and how this tool can save time and effort in the process.
15+
16+

0 commit comments

Comments
 (0)