universal-dev-standards/.usage-docs.yaml at main · AsiaOstrich/universal-dev-standards · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# Usage Documentation Generator Configuration
# 使用說明文件產生器配置
#
# This configuration defines how to generate comprehensive usage documentation
# from project source files. The generator reads this file to know:
# - What sources to scan (CLI, skills, commands, agents, workflows, standards)
# - What output formats to produce (reference, cheatsheet)
# - What languages to generate (en, zh-TW, zh-CN)

version: "1.0"

# Output configuration
output:
  directory: "docs/"
  formats:
    - reference    # FEATURE-REFERENCE.md - Complete feature documentation
    - cheatsheet   # CHEATSHEET.md - Single-page quick reference
  languages:
    - en           # English (primary)
    - zh-TW        # Traditional Chinese
    - zh-CN        # Simplified Chinese

  # Language-specific output paths
  paths:
    en: "docs/"
    zh-TW: "locales/zh-TW/docs/"
    zh-CN: "locales/zh-CN/docs/"

# Feature sources configuration
sources:
  # CLI Commands - parsed from Commander.js definitions
  cli:
    enabled: true
    entry: "cli/bin/uds.js"
    commands_dir: "cli/src/commands/"
    package: "cli/package.json"
    # Fields to extract
    fields:
      - name
      - description
      - options
      - examples

  # Skills - Claude Code skills with SKILL.md files
  skills:
    enabled: true
    directory: "skills/"
    pattern: "**/SKILL.md"
    exclude:
      - "commands/**"
      - "agents/**"
      - "workflows/**"
    # Frontmatter fields to extract
    frontmatter:
      - name
      - description
    # Content sections to extract
    sections:
      - purpose
      - quick-reference

  # Slash Commands - command definitions
  commands:
    enabled: true
    directory: "skills/commands/"
    pattern: "*.md"
    exclude:
      - "README.md"
      - "COMMAND-FAMILY-OVERVIEW.md"
    frontmatter:
      - description
      - allowed-tools
      - argument-hint

  # AI Agents - specialized agents
  agents:
    enabled: true
    directory: "skills/agents/"
    pattern: "*.md"
    exclude:
      - "README.md"
    frontmatter:
      - name
      - description
      - role
      - expertise
      - triggers
      - skills

  # Workflows - workflow definitions
  workflows:
    enabled: true
    directory: "skills/workflows/"
    pattern: "*.md"
    exclude:
      - "README.md"
    # YAML workflow files (if any)
    yaml_pattern: "*.workflow.yaml"
    fields:
      - name
      - description
      - steps
      - agents

  # Core Standards - fundamental development standards
  standards:
    enabled: true
    directory: "core/"
    pattern: "*.md"
    # Content sections to extract
    sections:
      - purpose
      - quick-reference
    # Metadata from document header
    metadata:
      - version
      - last-updated
      - applicability

  # Scripts - utility scripts
  scripts:
    enabled: true
    directory: "scripts/"
    patterns:
      - "*.sh"
      - "*.ps1"
      - "*.mjs"
    exclude:
      - "generate-usage-docs.mjs"  # Self-reference
    # Parse comments for description
    parse_header_comments: true

  # Templates - document templates
  templates:
    enabled: true
    directory: "templates/"
    pattern: "**/*.md"
    exclude:
      - "README.md"

# Translation configuration
translations:
  # Source file to translation mapping
  sources:
    en: ""  # Root directory (no prefix)
    zh-TW: "locales/zh-TW/"
    zh-CN: "locales/zh-CN/"

  # Translation metadata fields
  metadata:
    - source
    - source_version
    - translation_version
    - last_synced
    - status

# Document structure templates
templates:
  # FEATURE-REFERENCE.md structure
  reference:
    title:
      en: "UDS Feature Reference"
      zh-TW: "UDS 功能參考手冊"
      zh-CN: "UDS 功能参考手册"
    sections:
      - cli
      - commands
      - skills
      - agents
      - workflows
      - standards
      - scripts
      - templates

  # CHEATSHEET.md structure
  cheatsheet:
    title:
      en: "UDS Cheatsheet"
      zh-TW: "UDS 速查表"
      zh-CN: "UDS 速查表"
    format: "table"  # Table-based layout for quick reference

# Metadata
metadata:
  generator: "generate-usage-docs.mjs"
  project: "universal-dev-standards"
  repository: "https://github.com/AsiaOstrich/universal-dev-standards"