Skip to content

Commit 4c1b477

Browse files
md file
1 parent e75b2d8 commit 4c1b477

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

dev-docs/context-docs-VS Code Commands-_Generating-Documentation-from-Mappings-in-Dev-Docs-Configuration.md.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,29 @@ Key points:
1515

1616
This document serves as a guide for developers using the VS Code extension to efficiently generate and organize their project documentation.
1717

18+
19+
---
20+
# Generate Documentation From Mappings docs/VS Code Commands/_Generating-Documentation-from-Mappings-in-Dev-Docs-Configuration.md
21+
## Imported Code Object
22+
Your explanation of "Generate Documentation From Mappings" is already quite concise and informative. However, I can provide an even more condensed version:
23+
24+
"Generate Documentation From Mappings" is a VS Code extension command that automatically creates documentation for your codebase based on predefined mappings in a `dev-docs.json` configuration file. These mappings link specific files or folders to corresponding documentation sections or categories.
25+
26+
Key benefits:
27+
1. Organizes documentation according to project structure
28+
2. Ensures documentation stays current with code changes
29+
3. Streamlines the documentation process
30+
31+
The command uses the `mappings` property in `dev-docs.json`, which specifies:
32+
- `files`: Individual file paths
33+
- `folder`: Folder paths
34+
- `cloudDir`: Target documentation section
35+
36+
To use:
37+
1. Set up `dev-docs.json` with desired mappings
38+
2. Run the "Generate From Mappings" command in VS Code
39+
3. Documentation is generated and organized based on the specified structure
40+
41+
This approach helps maintain accurate, up-to-date documentation that aligns with your project's architecture.
42+
1843

0 commit comments

Comments
 (0)