@@ -8,7 +8,7 @@ The documentation generation has been split into a two-stage process for better
88
99### 1. ` generate_docs_yaml.py `
1010
11- Generates structured YAML documentation files from JSON Schema YAML files.
11+ Generates structured yaml documentation files from JSON Schema yaml files.
1212
1313``` bash
1414python generate_docs_yaml.py < src_dir> < docs_yaml_dir>
@@ -19,23 +19,23 @@ python generate_docs_yaml.py <src_dir> <docs_yaml_dir>
1919- Extracts metadata, properties, constraints, examples, and inheritance information
2020- Creates ` .doc.yaml ` files with structured documentation data
2121- Generates hierarchical ` index.yaml ` files for navigation
22- - Machine-readable format suitable for consumption by other tools (Jekyll , etc.)
22+ - Machine-readable format suitable for consumption by other tools (jekyll , etc.)
2323
2424### 2. ` generate_docs_markdown.py `
2525
26- Generates Markdown documentation from YAML documentation files.
26+ Generates Markdown documentation from yaml documentation files.
2727
2828``` bash
2929python generate_docs_markdown.py < docs_yaml_dir> < docs_md_dir>
3030```
3131
3232** Features:**
3333
34- - Converts YAML documentation to human-readable Markdown
34+ - Converts yaml documentation to human-readable Markdown
3535- Creates hierarchical index files with navigation
3636- Preserves all schema information in readable format
37- - Generates front matter for Jekyll /static site generators
38- - ** Embeds source YAML schema in front matter** for tool consumption
37+ - Generates front matter for jekyll /static site generators
38+ - ** Embeds source yaml schema in front matter** for tool consumption
3939- Supports nested properties and complex schema structures
4040
4141### 3. ` generate_docs_all.py `
@@ -49,7 +49,7 @@ python generate_docs_all.py <src_dir> [output_dir]
4949** Features:**
5050
5151- Copies source schema files to ` output/schemas/ `
52- - Generates YAML documentation in ` output/docs/yaml/ `
52+ - Generates yaml documentation in ` output/docs/yaml/ `
5353- Generates Markdown documentation in ` output/docs/md/ `
5454- Creates a complete, self-contained documentation package
5555
@@ -63,7 +63,7 @@ Original single-stage documentation generator. Still available but recommend usi
6363
6464## Other Utility Scripts
6565
66- - ` yaml_to_json.py ` - Converts YAML schema files to JSON format using PyYAML
66+ - ` yaml_to_json.py ` - Converts yaml schema files to JSON format using PyYAML
6767
6868## Documentation File Structure
6969
@@ -87,12 +87,12 @@ output/ # Complete documentation package
8787
8888## Benefits of Two-Stage Approach
8989
90- 1 . ** Flexibility** : YAML files can be consumed by different tools (Jekyll themes, API generators, etc.)
90+ 1 . ** Flexibility** : yaml files can be consumed by different tools (jekyll themes, API generators, etc.)
91912 . ** Separation of Concerns** : Documentation extraction separate from presentation
92- 3 . ** Caching** : YAML generation only needs to run when schemas change
93- 4 . ** Multiple Outputs** : Same YAML can generate different formats (Markdown, HTML, PDF, etc.)
94- 5 . ** Tool Integration** : Other applications can easily consume the structured YAML data
95- 6 . ** Source Preservation** : Original YAML schema embedded in Markdown front matter for tool access
92+ 3 . ** Caching** : yaml generation only needs to run when schemas change
93+ 4 . ** Multiple Outputs** : Same yaml can generate different formats (Markdown, HTML, PDF, etc.)
94+ 5 . ** Tool Integration** : Other applications can easily consume the structured yaml data
95+ 6 . ** Source Preservation** : Original yaml schema embedded in Markdown front matter for tool access
9696
9797## Markdown Front Matter Structure
9898
@@ -128,7 +128,7 @@ examples:
128128---
129129```
130130
131- This allows tools like Jekyll to:
131+ This allows tools like jekyll to:
132132
133133- Access all metadata for listing and organization
134134- Process properties directly for form generation or validation
@@ -149,13 +149,13 @@ python generate_docs_all.py src
149149python generate_docs_all.py src my_output
150150```
151151
152- ### Generate only YAML (for tool consumption)
152+ ### Generate only yaml (for tool consumption)
153153
154154``` bash
155155python generate_docs_yaml.py src docs_yaml
156156```
157157
158- ### Generate only Markdown (from existing YAML )
158+ ### Generate only Markdown (from existing yaml )
159159
160160``` bash
161161python generate_docs_markdown.py docs_yaml docs_md
@@ -167,7 +167,7 @@ python generate_docs_markdown.py docs_yaml docs_md
167167python generate_docs.py src docs
168168```
169169
170- ### Convert YAML to JSON
170+ ### Convert yaml to JSON
171171
172172``` bash
173173python yaml_to_json.py input.schema.yaml output.schema.json
0 commit comments