Skip to content

Commit 006f4c9

Browse files
md file
1 parent df07adb commit 006f4c9

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

dev-docs/context-docs-VS Code Commands-Generating-External-Documentation-with-Dev-Docs-VS-Code-Extension.md.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,26 @@ This code snippet explains the relevant configuration options in the `dev-docs.j
6363

6464
These options allow users to customize how the documentation is generated, what content is included, and how it's structured in the external documentation website.
6565

66+
---
67+
# Example JSON of relevant `dev-docs.json` options docs/VS Code Commands/Generating-External-Documentation-with-Dev-Docs-VS-Code-Extension.md
68+
## Imported Code Object
69+
This code snippet shows an example of a JSON configuration file named `dev-docs.json`. It contains options that are relevant for using a "Populate External Docs" command. Here's a brief explanation of the key elements:
70+
71+
1. "ai": The main object containing all the configuration options.
72+
73+
2. "internalTypeFilters": An array specifying which code elements to include (classes, methods, functions).
74+
75+
3. "codeFilters": An array of code patterns to look for in the source files.
76+
77+
4. "nameFilters": An array of specific function or method names to include.
78+
79+
5. "branch": Specifies which Git branch to use (in this case, "main").
80+
81+
6. "mappings": An array of objects that define how local files/folders map to cloud directories:
82+
- "files": Maps specific files to a cloud directory.
83+
- "folder": Maps entire folders to a cloud directory.
84+
- "cloudDir": Specifies the target cloud directory for the mapping.
85+
86+
This configuration helps automate the process of populating external documentation by defining what code elements to include and how to organize them in the cloud storage.
87+
6688

0 commit comments

Comments
 (0)