trinity-method-sdk 2.0.8 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/CHANGELOG.md +235 -0
  2. package/README.md +34 -35
  3. package/dist/cli/commands/deploy/agents.js +1 -1
  4. package/dist/cli/commands/deploy/claude-setup.js +28 -35
  5. package/dist/cli/commands/deploy/index.js +1 -1
  6. package/dist/cli/commands/deploy/knowledge-base.js +1 -1
  7. package/dist/cli/commands/deploy/root-files.js +1 -1
  8. package/dist/cli/commands/deploy/sdk-install.js +1 -1
  9. package/dist/cli/commands/deploy/templates.js +29 -16
  10. package/dist/cli/commands/update/agents.js +1 -1
  11. package/dist/cli/commands/update/commands.d.ts +1 -0
  12. package/dist/cli/commands/update/commands.js +18 -45
  13. package/dist/cli/commands/update/knowledge-base.js +1 -1
  14. package/dist/cli/commands/update/templates.js +34 -12
  15. package/dist/cli/utils/deploy-linting.js +1 -1
  16. package/dist/cli/utils/template-processor.js +1 -1
  17. package/dist/templates/{claude → .claude}/EMPLOYEE-DIRECTORY.md.template +1 -1
  18. package/dist/templates/{agents → .claude/agents}/aj-team/apo-documentation-specialist.md.template +3 -3
  19. package/dist/templates/{agents → .claude/agents}/aj-team/bas-quality-gate.md.template +6 -8
  20. package/dist/templates/{agents → .claude/agents}/aj-team/bon-dependency-manager.md.template +8 -8
  21. package/dist/templates/{agents → .claude/agents}/aj-team/cap-configuration-specialist.md.template +3 -3
  22. package/dist/templates/{agents → .claude/agents}/aj-team/dra-code-reviewer.md.template +5 -7
  23. package/dist/templates/{agents → .claude/agents}/aj-team/kil-task-executor.md.template +5 -7
  24. package/dist/templates/{agents → .claude/agents}/aj-team/uro-refactoring-specialist.md.template +3 -3
  25. package/dist/templates/{agents → .claude/agents}/audit/juno-auditor.md.template +7 -2
  26. package/dist/templates/{agents → .claude/agents}/deployment/ein-cicd.md.template +3 -4
  27. package/dist/templates/{agents → .claude/agents}/deployment/ino-context.md.template +6 -3
  28. package/dist/templates/{agents → .claude/agents}/deployment/tan-structure.md.template +4 -1
  29. package/dist/templates/{agents → .claude/agents}/deployment/zen-knowledge.md.template +11 -5
  30. package/dist/templates/{agents → .claude/agents}/leadership/aj-cc.md.template +7 -2
  31. package/dist/templates/{agents → .claude/agents}/leadership/aj-maestro.md.template +4 -0
  32. package/dist/templates/{agents → .claude/agents}/leadership/aly-cto.md.template +5 -1
  33. package/dist/templates/{agents → .claude/agents}/planning/eus-decomposer.md.template +4 -0
  34. package/dist/templates/{agents → .claude/agents}/planning/mon-requirements.md.template +4 -0
  35. package/dist/templates/{agents → .claude/agents}/planning/ror-design.md.template +4 -0
  36. package/dist/templates/{agents → .claude/agents}/planning/tra-planner.md.template +6 -0
  37. package/dist/templates/{shared/claude-commands → .claude/commands/execution}/trinity-audit.md.template +6 -6
  38. package/dist/templates/{shared/claude-commands → .claude/commands/execution}/trinity-orchestrate.md.template +5 -5
  39. package/dist/templates/{shared/claude-commands → .claude/commands/infrastructure}/trinity-init.md.template +12 -11
  40. package/dist/templates/{shared/claude-commands → .claude/commands/investigation}/trinity-create-investigation.md.template +8 -2
  41. package/dist/templates/{shared/claude-commands → .claude/commands/investigation}/trinity-investigate-templates.md.template +9 -5
  42. package/dist/templates/{shared/claude-commands → .claude/commands/investigation}/trinity-plan-investigation.md.template +11 -5
  43. package/dist/templates/{shared/claude-commands → .claude/commands/maintenance}/trinity-changelog.md.template +5 -4
  44. package/dist/templates/.claude/commands/maintenance/trinity-docs-update.md.template +279 -0
  45. package/dist/templates/.claude/commands/maintenance/trinity-docs.md.template +2828 -0
  46. package/dist/templates/{shared/claude-commands → .claude/commands/maintenance}/trinity-readme.md.template +144 -35
  47. package/dist/templates/{shared/claude-commands → .claude/commands/planning}/trinity-decompose.md.template +6 -4
  48. package/dist/templates/{shared/claude-commands → .claude/commands/planning}/trinity-design.md.template +6 -4
  49. package/dist/templates/{shared/claude-commands → .claude/commands/planning}/trinity-plan.md.template +7 -5
  50. package/dist/templates/{shared/claude-commands → .claude/commands/planning}/trinity-requirements.md.template +6 -4
  51. package/dist/templates/{shared/claude-commands → .claude/commands/session}/trinity-continue.md.template +9 -3
  52. package/dist/templates/{shared/claude-commands → .claude/commands/session}/trinity-end.md.template +8 -2
  53. package/dist/templates/{shared/claude-commands → .claude/commands/session}/trinity-start.md.template +8 -2
  54. package/dist/templates/{shared/claude-commands → .claude/commands/utility}/trinity-agents.md.template +8 -2
  55. package/dist/templates/{shared/claude-commands → .claude/commands/utility}/trinity-verify.md.template +9 -4
  56. package/dist/templates/{shared/claude-commands → .claude/commands/utility}/trinity-workorder.md.template +8 -4
  57. package/dist/templates/root/TRINITY.md.template +1 -1
  58. package/dist/templates/source/base-CLAUDE.md.template +310 -310
  59. package/dist/templates/source/flutter-CLAUDE.md.template +593 -593
  60. package/dist/templates/source/nodejs-CLAUDE.md.template +531 -531
  61. package/dist/templates/source/python-CLAUDE.md.template +510 -510
  62. package/dist/templates/source/react-CLAUDE.md.template +513 -513
  63. package/dist/templates/source/rust-CLAUDE.md.template +653 -653
  64. package/dist/templates/{knowledge-base → trinity/knowledge-base}/AI-DEVELOPMENT-GUIDE.md.template +1 -1
  65. package/dist/templates/{knowledge-base → trinity/knowledge-base}/ARCHITECTURE.md.template +3 -3
  66. package/dist/templates/{knowledge-base → trinity/knowledge-base}/CODING-PRINCIPLES.md.template +1 -1
  67. package/dist/templates/{knowledge-base → trinity/knowledge-base}/DOCUMENTATION-CRITERIA.md.template +1 -1
  68. package/dist/templates/{knowledge-base → trinity/knowledge-base}/ISSUES.md.template +3 -3
  69. package/dist/templates/{knowledge-base → trinity/knowledge-base}/TESTING-PRINCIPLES.md.template +1 -1
  70. package/dist/templates/{knowledge-base → trinity/knowledge-base}/Technical-Debt.md.template +3 -3
  71. package/dist/templates/{knowledge-base → trinity/knowledge-base}/To-do.md.template +3 -3
  72. package/dist/templates/{knowledge-base → trinity/knowledge-base}/Trinity.md.template +4 -3
  73. package/dist/templates/{documentation → trinity/templates/documentation}/SUBDIRECTORY-README.md.template +1 -1
  74. package/dist/templates/trinity/templates/documentation/api-docs/README.md.template +218 -0
  75. package/dist/templates/trinity/templates/documentation/configuration/documentation-structure.md.template +71 -0
  76. package/dist/templates/trinity/templates/documentation/configuration/env-example-generator.md.template +387 -0
  77. package/dist/templates/trinity/templates/documentation/discovery/api-endpoint-scanner.md.template +343 -0
  78. package/dist/templates/trinity/templates/documentation/discovery/component-discovery.md.template +254 -0
  79. package/dist/templates/trinity/templates/documentation/discovery/env-variable-extraction.md.template +316 -0
  80. package/dist/templates/trinity/templates/documentation/discovery/framework-detection.md.template +205 -0
  81. package/dist/templates/trinity/templates/documentation/guides/api-development.md.template +375 -0
  82. package/dist/templates/trinity/templates/documentation/guides/contributing.md.template +488 -0
  83. package/dist/templates/trinity/templates/documentation/guides/deployment.md.template +565 -0
  84. package/dist/templates/trinity/templates/documentation/guides/getting-started.md.template +118 -0
  85. package/dist/templates/trinity/templates/documentation/mermaid-diagrams/api-endpoint-map.md.template +56 -0
  86. package/dist/templates/trinity/templates/documentation/mermaid-diagrams/component-hierarchy.md.template +60 -0
  87. package/dist/templates/trinity/templates/documentation/mermaid-diagrams/database-er.md.template +49 -0
  88. package/dist/templates/trinity/templates/documentation/mermaid-diagrams/mvc-flow.md.template +41 -0
  89. package/dist/templates/trinity/templates/documentation/processes/error-handling-protocol.md.template +166 -0
  90. package/dist/templates/trinity/templates/documentation/processes/fallback-mechanism.md.template +88 -0
  91. package/dist/templates/trinity/templates/documentation/reports/apo-docs-update-checklist.md.template +343 -0
  92. package/dist/templates/trinity/templates/documentation/reports/juno-docs-update-checklist.md.template +1337 -0
  93. package/dist/templates/trinity/templates/documentation/reports/juno-final-report.md.template +237 -0
  94. package/dist/templates/trinity/templates/documentation/reports/juno-internal-report.md.template +461 -0
  95. package/dist/templates/trinity/templates/documentation/validation/documentation-verification-rules.md.template +379 -0
  96. package/dist/templates/trinity/templates/documentation/validation/juno-quality-gates.md.template +282 -0
  97. package/dist/templates/{investigations → trinity/templates/investigations}/bug.md.template +2 -2
  98. package/dist/templates/{investigations → trinity/templates/investigations}/feature.md.template +2 -2
  99. package/dist/templates/{investigations → trinity/templates/investigations}/performance.md.template +2 -2
  100. package/dist/templates/{investigations → trinity/templates/investigations}/security.md.template +2 -2
  101. package/dist/templates/{investigations → trinity/templates/investigations}/technical.md.template +2 -2
  102. package/dist/templates/{work-orders → trinity/templates/work-orders}/ANALYSIS-TEMPLATE.md.template +0 -3
  103. package/dist/templates/{work-orders → trinity/templates/work-orders}/AUDIT-TEMPLATE.md.template +0 -16
  104. package/dist/templates/{work-orders → trinity/templates/work-orders}/IMPLEMENTATION-TEMPLATE.md.template +0 -16
  105. package/dist/templates/{work-orders → trinity/templates/work-orders}/INVESTIGATION-TEMPLATE.md.template +0 -15
  106. package/dist/templates/{work-orders → trinity/templates/work-orders}/PATTERN-TEMPLATE.md.template +0 -16
  107. package/dist/templates/{work-orders → trinity/templates/work-orders}/VERIFICATION-TEMPLATE.md.template +0 -16
  108. package/package.json +1 -1
  109. package/dist/templates/shared/claude-commands/trinity-docs.md.template +0 -2208
  110. /package/dist/templates/{linting → root/linting}/flutter/.pre-commit-config.yaml.template +0 -0
  111. /package/dist/templates/{linting → root/linting}/flutter/analysis_options.yaml.template +0 -0
  112. /package/dist/templates/{linting → root/linting}/nodejs/.eslintrc-commonjs.json.template +0 -0
  113. /package/dist/templates/{linting → root/linting}/nodejs/.eslintrc-esm.json.template +0 -0
  114. /package/dist/templates/{linting → root/linting}/nodejs/.eslintrc-typescript.json.template +0 -0
  115. /package/dist/templates/{linting → root/linting}/nodejs/.pre-commit-config.yaml.template +0 -0
  116. /package/dist/templates/{linting → root/linting}/nodejs/.prettierrc.json.template +0 -0
  117. /package/dist/templates/{linting → root/linting}/python/.flake8.template +0 -0
  118. /package/dist/templates/{linting → root/linting}/python/.pre-commit-config.yaml.template +0 -0
  119. /package/dist/templates/{linting → root/linting}/python/pyproject.toml.template +0 -0
  120. /package/dist/templates/{linting → root/linting}/rust/.pre-commit-config.yaml.template +0 -0
  121. /package/dist/templates/{linting → root/linting}/rust/clippy.toml.template +0 -0
  122. /package/dist/templates/{linting → root/linting}/rust/rustfmt.toml.template +0 -0
  123. /package/dist/templates/{documentation → trinity/templates/documentation}/ROOT-README.md.template +0 -0
@@ -1,6 +1,6 @@
1
1
  # AI Development Guide
2
2
 
3
- **Version**: 2.0.0
3
+ **Trinity Version:** 2.1.0
4
4
  **Last Updated**: {{date}}
5
5
  **Project**: {{projectName}}
6
6
 
@@ -1,5 +1,5 @@
1
1
  # {{PROJECT_NAME}} Architecture
2
- **Trinity Method v2.0**
2
+ **Trinity Version:** 2.1.0
3
3
  **Technology Stack**: {{TECHNOLOGY_STACK}}
4
4
  **Framework**: {{PRIMARY_FRAMEWORK}}
5
5
  **Last Updated**: {{CURRENT_DATE}}
@@ -422,7 +422,7 @@ Updates_Required:
422
422
  2. **Update Content**: Make specific changes (don't just update timestamp)
423
423
  3. **Verify Placeholders**: Ensure no `{{VARIABLE}}` syntax introduced
424
424
  4. **Check Cross-References**: Update related documents if needed
425
- 5. **Update Timestamp**: Set `Last Updated: {{CURRENT_DATE}}` to actual date
425
+ 5. **Update Timestamp**: Set `**Last Updated**: {{CURRENT_DATE}}` to actual date
426
426
  6. **Git Commit**: Commit with message like "docs: update ARCHITECTURE.md - added UserAuth component"
427
427
 
428
428
  **Quality Checklist:**
@@ -449,4 +449,4 @@ Updates_Required:
449
449
  **Update Frequency**: As needed (session-based)
450
450
  **Maintained By**: Development team using Trinity Method
451
451
  **Referenced By**: `/trinity-end` command for session updates
452
- **Last Updated**: {{CURRENT_DATE}}
452
+ **Last Updated**: {{CURRENT_DATE}}
@@ -1,6 +1,6 @@
1
1
  # Coding Principles
2
2
 
3
- **Version**: 2.0.0
3
+ **Trinity Version:** 2.1.0
4
4
  **Last Updated**: {{date}}
5
5
  **Project**: {{projectName}}
6
6
 
@@ -1,6 +1,6 @@
1
1
  # Documentation Criteria
2
2
 
3
- **Version**: 2.0.0
3
+ **Trinity Version:** 2.1.0
4
4
  **Last Updated**: {{date}}
5
5
  **Project**: {{projectName}}
6
6
 
@@ -1,5 +1,5 @@
1
1
  # ISSUES.md - {{PROJECT_NAME}}
2
- **Trinity Method v2.0 - Issue Intelligence System**
2
+ **Trinity Version:** 2.1.0
3
3
  **Technology Stack**: {{TECHNOLOGY_STACK}}
4
4
  **Framework**: {{PRIMARY_FRAMEWORK}}
5
5
  **Last Updated**: {{CURRENT_DATE}}
@@ -482,7 +482,7 @@ Updates_Required:
482
482
  5. **Update Metrics**: Increment counts, update averages
483
483
  6. **Cross-Reference**: Update related documents (To-do, Technical-Debt, etc.)
484
484
  7. **Pattern Library**: Create trinity/patterns/ file if reusable solution
485
- 8. **Update Timestamp**: Set `Last Updated: {{CURRENT_DATE}}` to actual date
485
+ 8. **Update Timestamp**: Set `**Last Updated**: {{CURRENT_DATE}}` to actual date
486
486
 
487
487
  **Quality Checklist:**
488
488
  - [ ] Issue has complete symptoms, root cause, and solution
@@ -536,4 +536,4 @@ Updates_Required:
536
536
  ---
537
537
 
538
538
  *Issue tracking powered by Trinity Method v2.0*
539
- *Continuous pattern recognition and prevention system*
539
+ *Continuous pattern recognition and prevention system*
@@ -1,6 +1,6 @@
1
1
  # Testing Principles
2
2
 
3
- **Version**: 2.0.0
3
+ **Trinity Version:** 2.1.0
4
4
  **Last Updated**: {{date}}
5
5
  **Project**: {{projectName}}
6
6
 
@@ -1,5 +1,5 @@
1
1
  # Technical Debt Tracking - {{PROJECT_NAME}}
2
- **Trinity Method v2.0**
2
+ **Trinity Version:** 2.1.0
3
3
  **Technology Stack**: {{TECHNOLOGY_STACK}}
4
4
  **Framework**: {{PRIMARY_FRAMEWORK}}
5
5
  **Last Updated**: {{CURRENT_DATE}}
@@ -549,7 +549,7 @@ Updates_Required:
549
549
  4. **Calculate Trends**: Determine if debt is improving/degrading/stable
550
550
  5. **Update Cross-Refs**: Link related debt items to issues/todos
551
551
  6. **Prioritize**: Update debt reduction plan based on new ROI analysis
552
- 7. **Update Timestamp**: Set `Last Updated: {{CURRENT_DATE}}` to actual date
552
+ 7. **Update Timestamp**: Set `**Last Updated**: {{CURRENT_DATE}}` to actual date
553
553
 
554
554
  **Metric Calculation Commands** (for reference):
555
555
  ```bash
@@ -637,4 +637,4 @@ npm run test:coverage -- --json | jq '.total.lines.pct'
637
637
  ---
638
638
 
639
639
  *Technical Debt tracking powered by Trinity Method v2.0*
640
- *Continuous monitoring and reduction system*
640
+ *Continuous monitoring and reduction system*
@@ -1,5 +1,5 @@
1
1
  # To-do List - {{PROJECT_NAME}}
2
- **Trinity Method v2.0**
2
+ **Trinity Version:** 2.1.0
3
3
  **Technology Stack**: {{TECHNOLOGY_STACK}}
4
4
  **Framework**: {{PRIMARY_FRAMEWORK}}
5
5
  **Last Updated**: {{CURRENT_DATE}}
@@ -354,7 +354,7 @@ Updates_Required:
354
354
  2. **Update Section**: Modify appropriate priority section or backlog
355
355
  3. **Cross-Reference**: Check if ISSUES/Technical-Debt need updates
356
356
  4. **Recalculate Metrics**: Update velocity, sprint status if needed
357
- 5. **Update Timestamp**: Set `Last Updated: {{CURRENT_DATE}}`
357
+ 5. **Update Timestamp**: Set `**Last Updated**: {{CURRENT_DATE}}`
358
358
 
359
359
  **Quality Checklist:**
360
360
  - [ ] All tasks have clear descriptions (what needs to be done)
@@ -404,4 +404,4 @@ Updates_Required:
404
404
  ---
405
405
 
406
406
  *Task management powered by Trinity Method v2.0*
407
- *Investigation-first development approach*
407
+ *Investigation-first development approach*
@@ -1,5 +1,6 @@
1
1
  # Trinity Method Implementation - {{PROJECT_NAME}}
2
- **Version**: 7.0
2
+ **Trinity Version:** 2.1.0
3
+ **Last Updated**: {{date}}
3
4
  **Technology Stack**: {{TECHNOLOGY_STACK}}
4
5
  **Framework**: {{PRIMARY_FRAMEWORK}}
5
6
  **Last Updated**: {{CURRENT_DATE}}
@@ -431,7 +432,7 @@ Updates_Required:
431
432
  2. **Update Section**: Modify protocols, baselines, or workflows
432
433
  3. **Document Rationale**: Why was this change made?
433
434
  4. **Update Metrics**: Adjust success criteria if needed
434
- 5. **Update Timestamp**: Set `Last Updated: {{CURRENT_DATE}}`
435
+ 5. **Update Timestamp**: Set `**Last Updated**: {{CURRENT_DATE}}`
435
436
 
436
437
  **Quality Checklist:**
437
438
  - [ ] Change improves methodology (not just one-off adjustment)
@@ -461,4 +462,4 @@ Updates_Required:
461
462
  ---
462
463
 
463
464
  *Trinity Method implementation specific to {{PROJECT_NAME}}*
464
- *Continuously evolved based on project learnings*
465
+ *Continuously evolved based on project learnings*
@@ -238,7 +238,7 @@ See [Contributing Guidelines](../../CONTRIBUTING.md) for more details.
238
238
 
239
239
  ---
240
240
 
241
- **Last Updated:** {{CURRENT_DATE}}
241
+ **Last Updated**: {{CURRENT_DATE}}
242
242
 
243
243
  ---
244
244
 
@@ -0,0 +1,218 @@
1
+ # {{PROJECT_NAME}} API Documentation
2
+
3
+ Complete REST API reference for {{PROJECT_NAME}}.
4
+
5
+ ---
6
+
7
+ ## Overview
8
+
9
+ {{PROJECT_NAME}} provides **{{ENDPOINT_COUNT}} REST API endpoints** across **{{RESOURCE_COUNT}} resources**.
10
+
11
+ **Base URL:** `{{API_BASE_URL}}`
12
+
13
+ **API Version:** {{API_VERSION}}
14
+
15
+ ---
16
+
17
+ ## Authentication
18
+
19
+ {{AUTHENTICATION}}
20
+
21
+ ---
22
+
23
+ ## Request Format
24
+
25
+ All requests should include:
26
+
27
+ ```
28
+ Content-Type: application/json
29
+ {{AUTH_HEADER}}
30
+ ```
31
+
32
+ ---
33
+
34
+ ## Response Format
35
+
36
+ All responses are returned in JSON format:
37
+
38
+ ### Success Response
39
+
40
+ ```json
41
+ {
42
+ "data": { /* Response data */ },
43
+ "status": "success",
44
+ "timestamp": "2026-01-15T12:00:00Z"
45
+ }
46
+ ```
47
+
48
+ ### Error Response
49
+
50
+ ```json
51
+ {
52
+ "error": "Error message",
53
+ "statusCode": 400,
54
+ "timestamp": "2026-01-15T12:00:00Z",
55
+ "path": "/api/endpoint"
56
+ }
57
+ ```
58
+
59
+ ---
60
+
61
+ ## Status Codes
62
+
63
+ | Code | Meaning | Description |
64
+ |------|---------|-------------|
65
+ | 200 | OK | Request succeeded |
66
+ | 201 | Created | Resource created successfully |
67
+ | 204 | No Content | Request succeeded, no content to return |
68
+ | 400 | Bad Request | Invalid request parameters |
69
+ | 401 | Unauthorized | Authentication required |
70
+ | 403 | Forbidden | Insufficient permissions |
71
+ | 404 | Not Found | Resource not found |
72
+ | 409 | Conflict | Resource conflict (e.g., duplicate) |
73
+ | 422 | Unprocessable Entity | Validation error |
74
+ | 429 | Too Many Requests | Rate limit exceeded |
75
+ | 500 | Internal Server Error | Server error |
76
+
77
+ ---
78
+
79
+ ## Rate Limiting
80
+
81
+ {{RATE_LIMITING}}
82
+
83
+ ---
84
+
85
+ ## Pagination
86
+
87
+ List endpoints support pagination using query parameters:
88
+
89
+ ```
90
+ GET /api/resource?page=1&limit=20
91
+ ```
92
+
93
+ **Parameters:**
94
+ - `page` (integer, default: 1) - Page number
95
+ - `limit` (integer, default: 20, max: 100) - Items per page
96
+
97
+ **Response includes pagination metadata:**
98
+
99
+ ```json
100
+ {
101
+ "data": [ /* items */ ],
102
+ "pagination": {
103
+ "page": 1,
104
+ "limit": 20,
105
+ "total": 150,
106
+ "totalPages": 8
107
+ }
108
+ }
109
+ ```
110
+
111
+ ---
112
+
113
+ ## Filtering & Sorting
114
+
115
+ {{FILTERING_SORTING}}
116
+
117
+ ---
118
+
119
+ ## API Resources
120
+
121
+ {{RESOURCES}}
122
+
123
+ ---
124
+
125
+ ## Endpoints
126
+
127
+ {{ENDPOINT_DETAILS}}
128
+
129
+ ---
130
+
131
+ ## Error Codes
132
+
133
+ ### Common Errors
134
+
135
+ {{ERROR_CODES}}
136
+
137
+ ---
138
+
139
+ ## Code Examples
140
+
141
+ ### JavaScript (Fetch)
142
+
143
+ ```javascript
144
+ const response = await fetch('{{API_BASE_URL}}/{{EXAMPLE_ENDPOINT}}', {
145
+ method: 'GET',
146
+ headers: {
147
+ 'Content-Type': 'application/json',
148
+ {{AUTH_HEADER_EXAMPLE}}
149
+ }
150
+ });
151
+
152
+ const data = await response.json();
153
+ console.log(data);
154
+ ```
155
+
156
+ ### cURL
157
+
158
+ ```bash
159
+ curl -X GET '{{API_BASE_URL}}/{{EXAMPLE_ENDPOINT}}' \
160
+ -H 'Content-Type: application/json' \
161
+ {{CURL_AUTH_EXAMPLE}}
162
+ ```
163
+
164
+ ### Python (Requests)
165
+
166
+ ```python
167
+ import requests
168
+
169
+ response = requests.get(
170
+ '{{API_BASE_URL}}/{{EXAMPLE_ENDPOINT}}',
171
+ headers={
172
+ 'Content-Type': 'application/json',
173
+ {{PYTHON_AUTH_EXAMPLE}}
174
+ }
175
+ )
176
+
177
+ data = response.json()
178
+ print(data)
179
+ ```
180
+
181
+ ---
182
+
183
+ ## Webhooks
184
+
185
+ {{WEBHOOKS}}
186
+
187
+ ---
188
+
189
+ ## Versioning
190
+
191
+ {{API_VERSIONING}}
192
+
193
+ ---
194
+
195
+ ## Changelog
196
+
197
+ {{CHANGELOG}}
198
+
199
+ ---
200
+
201
+ ## Related Documentation
202
+
203
+ - [Getting Started](../guides/getting-started.md) - Setup and installation
204
+ - [API Development Guide](../guides/api-development.md) - Creating new endpoints
205
+ - [Deployment Guide](../guides/deployment.md) - Production deployment
206
+
207
+ ---
208
+
209
+ ## Support
210
+
211
+ For API support:
212
+ - **Documentation:** [Full documentation](../README.md)
213
+ - **Issues:** Report bugs via GitHub issues
214
+ - **Questions:** GitHub Discussions
215
+
216
+ ---
217
+
218
+ *Last updated: {{GENERATION_DATE}}*
@@ -0,0 +1,71 @@
1
+ # Documentation Structure Configuration
2
+
3
+ ## Template Paths
4
+
5
+ All documentation templates follow a consistent directory structure:
6
+
7
+ ### Core Templates
8
+ - **Root README**: `src/templates/documentation/ROOT-README.md.template`
9
+ - **Subdirectory README**: `src/templates/documentation/SUBDIRECTORY-README.md.template`
10
+
11
+ ### Mermaid Diagrams (`mermaid-diagrams/`)
12
+ - `mvc-flow.md.template` - MVC architecture flow
13
+ - `database-er.md.template` - Database entity relationships
14
+ - `component-hierarchy.md.template` - Component dependency tree
15
+ - `api-endpoint-map.md.template` - API endpoint organization
16
+
17
+ ### Guides (`guides/`)
18
+ - `getting-started.md.template` - Initial setup and onboarding
19
+ - `api-development.md.template` - API development patterns
20
+ - `deployment.md.template` - Deployment procedures
21
+ - `contributing.md.template` - Contribution guidelines
22
+
23
+ ### API Documentation (`api-docs/`)
24
+ - `README.md.template` - API reference structure
25
+
26
+ ### Configuration (`config/`)
27
+ - `env-example-generator.md.template` - Environment variable examples
28
+
29
+ ### Reports (`reports/`)
30
+ - `juno-final-report.md.template` - Public documentation report
31
+ - `juno-internal-report.md.template` - Internal audit report
32
+
33
+ ### Discovery (`discovery/`)
34
+ - `framework-detection.md.template` - Framework identification patterns
35
+ - `component-discovery.md.template` - Component scanning logic
36
+ - `api-endpoint-scanner.md.template` - API endpoint detection
37
+ - `env-variable-extraction.md.template` - Environment variable parsing
38
+
39
+ ### Validation (`validation/`)
40
+ - `juno-quality-gates.md.template` - Quality gate criteria
41
+ - `documentation-verification-rules.md.template` - Verification rules
42
+ - `apo-self-validation.md.template` - APO self-check procedures
43
+
44
+ ### Processes (`processes/`)
45
+ - `error-handling-protocol.md.template` - Error handling standards
46
+ - `apo-workflow-common.md.template` - Common APO workflow steps
47
+ - `apo-diagram-specific.md.template` - Diagram-specific workflow
48
+ - `apo-guide-specific.md.template` - Guide-specific workflow
49
+ - `apo-config-specific.md.template` - Configuration-specific workflow
50
+ - `fallback-mechanism.md.template` - Fallback procedures
51
+
52
+ ## Component Discovery Patterns
53
+
54
+ **Search patterns for framework components:**
55
+ - Controllers: `**/*Controller.{js,ts,py,rb,go,java,cs,php}`
56
+ - Models: `**/models/**/*.{js,ts,py,rb,go,java,cs,php}`
57
+ - Services: `**/services/**/*.{js,ts,py,rb,go,java,cs,php}`
58
+ - Routes: `**/routes/**/*.{js,ts,py,rb,go,java,cs,php}`
59
+
60
+ ## Verification Glob Patterns
61
+
62
+ **Quality gate file checks:**
63
+ ```javascript
64
+ const verification_globs = [
65
+ "docs/**/README.md",
66
+ "docs/diagrams/**/*.md",
67
+ "docs/guides/**/*.md",
68
+ "docs/api/**/*.md",
69
+ ".env.example"
70
+ ];
71
+ ```