ace-docs 0.31.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 (91) hide show
  1. checksums.yaml +7 -0
  2. data/.ace-defaults/docs/config.yml +169 -0
  3. data/.ace-defaults/docs/multi-subject-example.md +130 -0
  4. data/.ace-defaults/docs/single-subject-example.md +150 -0
  5. data/.ace-defaults/nav/protocols/guide-sources/ace-docs.yml +10 -0
  6. data/.ace-defaults/nav/protocols/prompt-sources/ace-docs.yml +34 -0
  7. data/.ace-defaults/nav/protocols/tmpl-sources/ace-docs.yml +10 -0
  8. data/.ace-defaults/nav/protocols/wfi-sources/ace-docs.yml +19 -0
  9. data/CHANGELOG.md +1082 -0
  10. data/LICENSE +21 -0
  11. data/README.md +40 -0
  12. data/Rakefile +14 -0
  13. data/exe/ace-docs +14 -0
  14. data/handbook/guides/documentation/ruby.md +16 -0
  15. data/handbook/guides/documentation/rust.md +35 -0
  16. data/handbook/guides/documentation/typescript.md +18 -0
  17. data/handbook/guides/documentation.g.md +437 -0
  18. data/handbook/guides/documents-embedded-sync.g.md +473 -0
  19. data/handbook/guides/documents-embedding.g.md +276 -0
  20. data/handbook/guides/markdown-style.g.md +290 -0
  21. data/handbook/prompts/ace-change-analyzer.system.md +113 -0
  22. data/handbook/prompts/ace-change-analyzer.user.md +95 -0
  23. data/handbook/prompts/document-analysis.md +74 -0
  24. data/handbook/prompts/document-analysis.system.md +129 -0
  25. data/handbook/prompts/markdown-style.system.md +113 -0
  26. data/handbook/skills/as-docs-create-adr/SKILL.md +35 -0
  27. data/handbook/skills/as-docs-create-api/SKILL.md +35 -0
  28. data/handbook/skills/as-docs-create-user/SKILL.md +35 -0
  29. data/handbook/skills/as-docs-maintain-adrs/SKILL.md +35 -0
  30. data/handbook/skills/as-docs-squash-changelog/SKILL.md +42 -0
  31. data/handbook/skills/as-docs-update/SKILL.md +36 -0
  32. data/handbook/skills/as-docs-update-blueprint/SKILL.md +28 -0
  33. data/handbook/skills/as-docs-update-roadmap/SKILL.md +24 -0
  34. data/handbook/skills/as-docs-update-tools/SKILL.md +36 -0
  35. data/handbook/skills/as-docs-update-usage/SKILL.md +26 -0
  36. data/handbook/templates/code-docs/javascript-jsdoc.template.md +102 -0
  37. data/handbook/templates/code-docs/ruby-yard.template.md +85 -0
  38. data/handbook/templates/project-docs/README.template.md +73 -0
  39. data/handbook/templates/project-docs/architecture.template.md +300 -0
  40. data/handbook/templates/project-docs/blueprint.template.md +165 -0
  41. data/handbook/templates/project-docs/context/ownership.yml +160 -0
  42. data/handbook/templates/project-docs/decisions/adr.template.md +60 -0
  43. data/handbook/templates/project-docs/prd.template.md +144 -0
  44. data/handbook/templates/project-docs/roadmap/roadmap.template.md +47 -0
  45. data/handbook/templates/project-docs/vision.template.md +233 -0
  46. data/handbook/templates/user-docs/user-guide.template.md +107 -0
  47. data/handbook/workflow-instructions/docs/create-adr.wf.md +334 -0
  48. data/handbook/workflow-instructions/docs/create-api.wf.md +448 -0
  49. data/handbook/workflow-instructions/docs/create-cookbook.wf.md +434 -0
  50. data/handbook/workflow-instructions/docs/create-user.wf.md +399 -0
  51. data/handbook/workflow-instructions/docs/maintain-adrs.wf.md +589 -0
  52. data/handbook/workflow-instructions/docs/squash-changelog.wf.md +246 -0
  53. data/handbook/workflow-instructions/docs/update-blueprint.wf.md +361 -0
  54. data/handbook/workflow-instructions/docs/update-context.wf.md +336 -0
  55. data/handbook/workflow-instructions/docs/update-roadmap.wf.md +421 -0
  56. data/handbook/workflow-instructions/docs/update-tools.wf.md +307 -0
  57. data/handbook/workflow-instructions/docs/update-usage.wf.md +710 -0
  58. data/handbook/workflow-instructions/docs/update.wf.md +418 -0
  59. data/lib/ace/docs/atoms/diff_filterer.rb +131 -0
  60. data/lib/ace/docs/atoms/frontmatter_free_matcher.rb +20 -0
  61. data/lib/ace/docs/atoms/git_date_resolver.rb +16 -0
  62. data/lib/ace/docs/atoms/readme_metadata_inferrer.rb +60 -0
  63. data/lib/ace/docs/atoms/terminology_extractor.rb +308 -0
  64. data/lib/ace/docs/atoms/time_range_calculator.rb +96 -0
  65. data/lib/ace/docs/atoms/timestamp_parser.rb +106 -0
  66. data/lib/ace/docs/atoms/type_inferrer.rb +70 -0
  67. data/lib/ace/docs/cli/commands/analyze.rb +351 -0
  68. data/lib/ace/docs/cli/commands/analyze_consistency.rb +185 -0
  69. data/lib/ace/docs/cli/commands/discover.rb +75 -0
  70. data/lib/ace/docs/cli/commands/scope_options.rb +71 -0
  71. data/lib/ace/docs/cli/commands/status.rb +241 -0
  72. data/lib/ace/docs/cli/commands/update.rb +198 -0
  73. data/lib/ace/docs/cli/commands/validate.rb +225 -0
  74. data/lib/ace/docs/cli.rb +60 -0
  75. data/lib/ace/docs/models/analysis_report.rb +120 -0
  76. data/lib/ace/docs/models/consistency_report.rb +259 -0
  77. data/lib/ace/docs/models/document.rb +354 -0
  78. data/lib/ace/docs/molecules/change_detector.rb +389 -0
  79. data/lib/ace/docs/molecules/document_loader.rb +133 -0
  80. data/lib/ace/docs/molecules/frontmatter_manager.rb +85 -0
  81. data/lib/ace/docs/molecules/git_date_resolver.rb +30 -0
  82. data/lib/ace/docs/organisms/cross_document_analyzer.rb +274 -0
  83. data/lib/ace/docs/organisms/document_registry.rb +318 -0
  84. data/lib/ace/docs/organisms/validator.rb +164 -0
  85. data/lib/ace/docs/prompts/compact_diff_prompt.rb +119 -0
  86. data/lib/ace/docs/prompts/consistency_prompt.rb +286 -0
  87. data/lib/ace/docs/prompts/document_analysis_prompt.rb +389 -0
  88. data/lib/ace/docs/version.rb +7 -0
  89. data/lib/ace/docs.rb +82 -0
  90. data/lib/test.rb +4 -0
  91. metadata +347 -0
metadata ADDED
@@ -0,0 +1,347 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ace-docs
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.31.0
5
+ platform: ruby
6
+ authors:
7
+ - Michal Czyz
8
+ bindir: exe
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: ace-support-config
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - "~>"
17
+ - !ruby/object:Gem::Version
18
+ version: '0.8'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - "~>"
24
+ - !ruby/object:Gem::Version
25
+ version: '0.8'
26
+ - !ruby/object:Gem::Dependency
27
+ name: ace-support-core
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - "~>"
31
+ - !ruby/object:Gem::Version
32
+ version: '0.25'
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - "~>"
38
+ - !ruby/object:Gem::Version
39
+ version: '0.25'
40
+ - !ruby/object:Gem::Dependency
41
+ name: ace-git
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - "~>"
45
+ - !ruby/object:Gem::Version
46
+ version: '0.10'
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - "~>"
52
+ - !ruby/object:Gem::Version
53
+ version: '0.10'
54
+ - !ruby/object:Gem::Dependency
55
+ name: ace-b36ts
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - "~>"
59
+ - !ruby/object:Gem::Version
60
+ version: '0.7'
61
+ type: :runtime
62
+ prerelease: false
63
+ version_requirements: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: '0.7'
68
+ - !ruby/object:Gem::Dependency
69
+ name: ace-llm
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
73
+ - !ruby/object:Gem::Version
74
+ version: '0.26'
75
+ type: :runtime
76
+ prerelease: false
77
+ version_requirements: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '0.26'
82
+ - !ruby/object:Gem::Dependency
83
+ name: ace-support-markdown
84
+ requirement: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - "~>"
87
+ - !ruby/object:Gem::Version
88
+ version: '0.2'
89
+ type: :runtime
90
+ prerelease: false
91
+ version_requirements: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - "~>"
94
+ - !ruby/object:Gem::Version
95
+ version: '0.2'
96
+ - !ruby/object:Gem::Dependency
97
+ name: ace-support-cli
98
+ requirement: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - "~>"
101
+ - !ruby/object:Gem::Version
102
+ version: '0.3'
103
+ type: :runtime
104
+ prerelease: false
105
+ version_requirements: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - "~>"
108
+ - !ruby/object:Gem::Version
109
+ version: '0.3'
110
+ - !ruby/object:Gem::Dependency
111
+ name: yaml
112
+ requirement: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - "~>"
115
+ - !ruby/object:Gem::Version
116
+ version: '0.3'
117
+ type: :runtime
118
+ prerelease: false
119
+ version_requirements: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - "~>"
122
+ - !ruby/object:Gem::Version
123
+ version: '0.3'
124
+ - !ruby/object:Gem::Dependency
125
+ name: colorize
126
+ requirement: !ruby/object:Gem::Requirement
127
+ requirements:
128
+ - - "~>"
129
+ - !ruby/object:Gem::Version
130
+ version: '1.1'
131
+ type: :runtime
132
+ prerelease: false
133
+ version_requirements: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - "~>"
136
+ - !ruby/object:Gem::Version
137
+ version: '1.1'
138
+ - !ruby/object:Gem::Dependency
139
+ name: terminal-table
140
+ requirement: !ruby/object:Gem::Requirement
141
+ requirements:
142
+ - - "~>"
143
+ - !ruby/object:Gem::Version
144
+ version: '3.0'
145
+ type: :runtime
146
+ prerelease: false
147
+ version_requirements: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - "~>"
150
+ - !ruby/object:Gem::Version
151
+ version: '3.0'
152
+ - !ruby/object:Gem::Dependency
153
+ name: fileutils
154
+ requirement: !ruby/object:Gem::Requirement
155
+ requirements:
156
+ - - "~>"
157
+ - !ruby/object:Gem::Version
158
+ version: '1.7'
159
+ type: :runtime
160
+ prerelease: false
161
+ version_requirements: !ruby/object:Gem::Requirement
162
+ requirements:
163
+ - - "~>"
164
+ - !ruby/object:Gem::Version
165
+ version: '1.7'
166
+ - !ruby/object:Gem::Dependency
167
+ name: minitest
168
+ requirement: !ruby/object:Gem::Requirement
169
+ requirements:
170
+ - - "~>"
171
+ - !ruby/object:Gem::Version
172
+ version: '5.19'
173
+ type: :development
174
+ prerelease: false
175
+ version_requirements: !ruby/object:Gem::Requirement
176
+ requirements:
177
+ - - "~>"
178
+ - !ruby/object:Gem::Version
179
+ version: '5.19'
180
+ - !ruby/object:Gem::Dependency
181
+ name: rake
182
+ requirement: !ruby/object:Gem::Requirement
183
+ requirements:
184
+ - - "~>"
185
+ - !ruby/object:Gem::Version
186
+ version: '13.0'
187
+ type: :development
188
+ prerelease: false
189
+ version_requirements: !ruby/object:Gem::Requirement
190
+ requirements:
191
+ - - "~>"
192
+ - !ruby/object:Gem::Version
193
+ version: '13.0'
194
+ - !ruby/object:Gem::Dependency
195
+ name: rubocop
196
+ requirement: !ruby/object:Gem::Requirement
197
+ requirements:
198
+ - - "~>"
199
+ - !ruby/object:Gem::Version
200
+ version: '1.57'
201
+ type: :development
202
+ prerelease: false
203
+ version_requirements: !ruby/object:Gem::Requirement
204
+ requirements:
205
+ - - "~>"
206
+ - !ruby/object:Gem::Version
207
+ version: '1.57'
208
+ - !ruby/object:Gem::Dependency
209
+ name: simplecov
210
+ requirement: !ruby/object:Gem::Requirement
211
+ requirements:
212
+ - - "~>"
213
+ - !ruby/object:Gem::Version
214
+ version: '0.22'
215
+ type: :development
216
+ prerelease: false
217
+ version_requirements: !ruby/object:Gem::Requirement
218
+ requirements:
219
+ - - "~>"
220
+ - !ruby/object:Gem::Version
221
+ version: '0.22'
222
+ description: 'Documentation management for teams and agents: track freshness from
223
+ frontmatter, detect drift from git history, run LLM-powered analysis, and validate
224
+ consistency across docs.'
225
+ email:
226
+ - mc@cs3b.com
227
+ executables:
228
+ - ace-docs
229
+ extensions: []
230
+ extra_rdoc_files: []
231
+ files:
232
+ - ".ace-defaults/docs/config.yml"
233
+ - ".ace-defaults/docs/multi-subject-example.md"
234
+ - ".ace-defaults/docs/single-subject-example.md"
235
+ - ".ace-defaults/nav/protocols/guide-sources/ace-docs.yml"
236
+ - ".ace-defaults/nav/protocols/prompt-sources/ace-docs.yml"
237
+ - ".ace-defaults/nav/protocols/tmpl-sources/ace-docs.yml"
238
+ - ".ace-defaults/nav/protocols/wfi-sources/ace-docs.yml"
239
+ - CHANGELOG.md
240
+ - LICENSE
241
+ - README.md
242
+ - Rakefile
243
+ - exe/ace-docs
244
+ - handbook/guides/documentation.g.md
245
+ - handbook/guides/documentation/ruby.md
246
+ - handbook/guides/documentation/rust.md
247
+ - handbook/guides/documentation/typescript.md
248
+ - handbook/guides/documents-embedded-sync.g.md
249
+ - handbook/guides/documents-embedding.g.md
250
+ - handbook/guides/markdown-style.g.md
251
+ - handbook/prompts/ace-change-analyzer.system.md
252
+ - handbook/prompts/ace-change-analyzer.user.md
253
+ - handbook/prompts/document-analysis.md
254
+ - handbook/prompts/document-analysis.system.md
255
+ - handbook/prompts/markdown-style.system.md
256
+ - handbook/skills/as-docs-create-adr/SKILL.md
257
+ - handbook/skills/as-docs-create-api/SKILL.md
258
+ - handbook/skills/as-docs-create-user/SKILL.md
259
+ - handbook/skills/as-docs-maintain-adrs/SKILL.md
260
+ - handbook/skills/as-docs-squash-changelog/SKILL.md
261
+ - handbook/skills/as-docs-update-blueprint/SKILL.md
262
+ - handbook/skills/as-docs-update-roadmap/SKILL.md
263
+ - handbook/skills/as-docs-update-tools/SKILL.md
264
+ - handbook/skills/as-docs-update-usage/SKILL.md
265
+ - handbook/skills/as-docs-update/SKILL.md
266
+ - handbook/templates/code-docs/javascript-jsdoc.template.md
267
+ - handbook/templates/code-docs/ruby-yard.template.md
268
+ - handbook/templates/project-docs/README.template.md
269
+ - handbook/templates/project-docs/architecture.template.md
270
+ - handbook/templates/project-docs/blueprint.template.md
271
+ - handbook/templates/project-docs/context/ownership.yml
272
+ - handbook/templates/project-docs/decisions/adr.template.md
273
+ - handbook/templates/project-docs/prd.template.md
274
+ - handbook/templates/project-docs/roadmap/roadmap.template.md
275
+ - handbook/templates/project-docs/vision.template.md
276
+ - handbook/templates/user-docs/user-guide.template.md
277
+ - handbook/workflow-instructions/docs/create-adr.wf.md
278
+ - handbook/workflow-instructions/docs/create-api.wf.md
279
+ - handbook/workflow-instructions/docs/create-cookbook.wf.md
280
+ - handbook/workflow-instructions/docs/create-user.wf.md
281
+ - handbook/workflow-instructions/docs/maintain-adrs.wf.md
282
+ - handbook/workflow-instructions/docs/squash-changelog.wf.md
283
+ - handbook/workflow-instructions/docs/update-blueprint.wf.md
284
+ - handbook/workflow-instructions/docs/update-context.wf.md
285
+ - handbook/workflow-instructions/docs/update-roadmap.wf.md
286
+ - handbook/workflow-instructions/docs/update-tools.wf.md
287
+ - handbook/workflow-instructions/docs/update-usage.wf.md
288
+ - handbook/workflow-instructions/docs/update.wf.md
289
+ - lib/ace/docs.rb
290
+ - lib/ace/docs/atoms/diff_filterer.rb
291
+ - lib/ace/docs/atoms/frontmatter_free_matcher.rb
292
+ - lib/ace/docs/atoms/git_date_resolver.rb
293
+ - lib/ace/docs/atoms/readme_metadata_inferrer.rb
294
+ - lib/ace/docs/atoms/terminology_extractor.rb
295
+ - lib/ace/docs/atoms/time_range_calculator.rb
296
+ - lib/ace/docs/atoms/timestamp_parser.rb
297
+ - lib/ace/docs/atoms/type_inferrer.rb
298
+ - lib/ace/docs/cli.rb
299
+ - lib/ace/docs/cli/commands/analyze.rb
300
+ - lib/ace/docs/cli/commands/analyze_consistency.rb
301
+ - lib/ace/docs/cli/commands/discover.rb
302
+ - lib/ace/docs/cli/commands/scope_options.rb
303
+ - lib/ace/docs/cli/commands/status.rb
304
+ - lib/ace/docs/cli/commands/update.rb
305
+ - lib/ace/docs/cli/commands/validate.rb
306
+ - lib/ace/docs/models/analysis_report.rb
307
+ - lib/ace/docs/models/consistency_report.rb
308
+ - lib/ace/docs/models/document.rb
309
+ - lib/ace/docs/molecules/change_detector.rb
310
+ - lib/ace/docs/molecules/document_loader.rb
311
+ - lib/ace/docs/molecules/frontmatter_manager.rb
312
+ - lib/ace/docs/molecules/git_date_resolver.rb
313
+ - lib/ace/docs/organisms/cross_document_analyzer.rb
314
+ - lib/ace/docs/organisms/document_registry.rb
315
+ - lib/ace/docs/organisms/validator.rb
316
+ - lib/ace/docs/prompts/compact_diff_prompt.rb
317
+ - lib/ace/docs/prompts/consistency_prompt.rb
318
+ - lib/ace/docs/prompts/document_analysis_prompt.rb
319
+ - lib/ace/docs/version.rb
320
+ - lib/test.rb
321
+ homepage: https://github.com/cs3b/ace
322
+ licenses:
323
+ - MIT
324
+ metadata:
325
+ allowed_push_host: https://rubygems.org
326
+ homepage_uri: https://github.com/cs3b/ace
327
+ source_code_uri: https://github.com/cs3b/ace/tree/main/ace-docs/
328
+ changelog_uri: https://github.com/cs3b/ace/blob/main/ace-docs/CHANGELOG.md
329
+ rdoc_options: []
330
+ require_paths:
331
+ - lib
332
+ required_ruby_version: !ruby/object:Gem::Requirement
333
+ requirements:
334
+ - - ">="
335
+ - !ruby/object:Gem::Version
336
+ version: 3.2.0
337
+ required_rubygems_version: !ruby/object:Gem::Requirement
338
+ requirements:
339
+ - - ">="
340
+ - !ruby/object:Gem::Version
341
+ version: '0'
342
+ requirements: []
343
+ rubygems_version: 3.6.9
344
+ specification_version: 4
345
+ summary: Keep documentation current with freshness tracking, drift detection, and
346
+ LLM suggestions
347
+ test_files: []