Skip to content

Commit 59ca5d3

Browse files
md file
1 parent 4c1b477 commit 59ca5d3

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

dev-docs/context-docs-VS Code Commands-_Generating-Folder-Documentation-with-Dev-Docs.md.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,23 @@ This file provides documentation for the "Generate Documentation for a Folder" c
1313

1414
The document is structured to give users a comprehensive understanding of the feature, its benefits, and how to implement it effectively in their projects. It serves as a guide for developers looking to improve their project documentation using the Dev-Docs extension in Visual Studio Code.
1515

16+
17+
---
18+
# Example JSON of Relevant `dev-docs.json` Options docs/VS Code Commands/_Generating-Folder-Documentation-with-Dev-Docs.md
19+
## Imported Code Object
20+
Certainly! This JSON snippet represents a configuration for organizing and mapping project directories to cloud storage or documentation structures. Here's a concise explanation:
21+
22+
1. `contextDirs`: An array specifying the directories to be included in the documentation or processing context. In this case, it includes "src/components" and "src/utils".
23+
24+
2. `mappings`: An array of objects that define how local folders should be mapped to cloud or documentation directories:
25+
- Each object has two properties:
26+
- `folder`: An array of local directory paths to be mapped.
27+
- `cloudDir`: The corresponding cloud or documentation directory name.
28+
29+
In this example:
30+
- Files from "src/components" will be mapped to "UI Components" in the cloud or documentation structure.
31+
- Files from "src/utils" will be mapped to "Utility Functions" in the cloud or documentation structure.
32+
33+
This configuration helps in organizing and structuring project files when generating documentation or syncing with cloud storage.
34+
1635

0 commit comments

Comments
 (0)