ace-handbook 0.19.0 → 0.21.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +97 -2
- data/README.md +1 -1
- data/handbook/guides/cli-dry-cli.g.md +4 -0
- data/handbook/guides/cli-support-cli.g.md +4 -0
- data/handbook/guides/coding-standards/ruby.md +1 -1
- data/handbook/guides/coding-standards.g.md +27 -0
- data/handbook/guides/debug-troubleshooting.g.md +11 -1
- data/handbook/guides/error-handling.g.md +6 -0
- data/handbook/guides/meta/agents-definition.g.md +94 -2
- data/handbook/guides/meta/guides-definition.g.md +31 -9
- data/handbook/guides/meta/markdown-definition.g.md +31 -1
- data/handbook/guides/meta/tools-definition.g.md +5 -0
- data/handbook/guides/meta/workflow-instructions-definition.g.md +37 -0
- data/handbook/guides/mono-repo-patterns.g.md +1 -0
- data/handbook/guides/multi-agent-research.g.md +5 -1
- data/handbook/guides/performance.g.md +7 -0
- data/handbook/guides/strategic-planning.g.md +2 -2
- data/handbook/guides/troubleshooting/ruby.md +14 -10
- data/handbook/guides/troubleshooting/rust.md +11 -9
- data/handbook/guides/troubleshooting/typescript.md +11 -9
- data/handbook/guides/workflow-context-embedding.g.md +16 -0
- data/handbook/templates/completed-work-documentation.md +5 -1
- data/handbook/templates/cookbooks/cookbook.template.md +21 -1
- data/handbook/templates/research-comparison.template.md +7 -6
- data/handbook/workflow-instructions/handbook/init-project.wf.md +78 -1
- data/handbook/workflow-instructions/handbook/manage-agents.wf.md +40 -0
- data/handbook/workflow-instructions/handbook/manage-guides.wf.md +30 -30
- data/handbook/workflow-instructions/handbook/manage-workflows.wf.md +36 -30
- data/handbook/workflow-instructions/handbook/parallel-research.wf.md +15 -0
- data/handbook/workflow-instructions/handbook/perform-delivery.wf.md +6 -1
- data/handbook/workflow-instructions/handbook/research.wf.md +5 -0
- data/handbook/workflow-instructions/handbook/review-guides.wf.md +45 -45
- data/handbook/workflow-instructions/handbook/review-workflows.wf.md +30 -30
- data/handbook/workflow-instructions/handbook/synthesize-research.wf.md +15 -0
- data/handbook/workflow-instructions/handbook/update-docs.wf.md +29 -21
- data/lib/ace/handbook/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 601dc9817570da785077875d586005bd52693f9fda174cbd6c6ab1a52caff72c
|
|
4
|
+
data.tar.gz: 6fac18f1c2b84444de63d4922f959c0ea75d7ac949778ebb614d60a5a27a06aa
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0d81b467e7f3a34c6856a37732072703ce582088a9c8a1706e5f9c6c2c3cdd1b2b7d24f4067202b2e9594d3b3df6c4a1c9fd8282ab9a912d43856a5f783c5a16
|
|
7
|
+
data.tar.gz: 41c864dc6543d3de1b63af4e9107c34f3b4ebc7c03c3861424c005db288ef557f4509158d67869cf86b052242832e397876c1e6f95ba7fa7f62f5c75d0b23479
|
data/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
# Changelog
|
|
2
|
+
|
|
2
3
|
All notable changes to this project will be documented in this file.
|
|
3
4
|
|
|
4
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
@@ -6,18 +7,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
6
7
|
|
|
7
8
|
## [Unreleased]
|
|
8
9
|
|
|
10
|
+
## [0.21.0] - 2026-03-28
|
|
11
|
+
|
|
12
|
+
### Changed
|
|
13
|
+
|
|
14
|
+
- Migrated most RubyGems publish decision logic into `wfi://release/rubygems-publish`, keeping `as-release-rubygems-publish` as a thin workflow wrapper.
|
|
15
|
+
|
|
16
|
+
### Technical
|
|
17
|
+
|
|
18
|
+
- Removed skill-local pending-release-discovery preference logic and aligned the workflow with build-first + single-OTP publish behavior.
|
|
19
|
+
|
|
20
|
+
## [0.20.0] - 2026-03-28
|
|
21
|
+
|
|
22
|
+
### Added
|
|
23
|
+
|
|
24
|
+
- Added `bin/ace-rubygems-needs-release` to derive pending ACE RubyGems releases from a single remote snapshot instead of querying each gem individually.
|
|
25
|
+
|
|
26
|
+
### Changed
|
|
27
|
+
|
|
28
|
+
- Updated the RubyGems publish workflow to prefer the helper script when available and corrected the fallback `gem search --exact` guidance.
|
|
29
|
+
- Updated `as-release-rubygems-publish` skill instructions to prefer the helper script for pending-release discovery.
|
|
30
|
+
|
|
9
31
|
## [0.19.0] - 2026-03-23
|
|
10
32
|
|
|
11
33
|
### Added
|
|
34
|
+
|
|
12
35
|
- New use case in README documenting `ace-handbook sync` and `ace-handbook status` CLI commands.
|
|
13
36
|
- Added `as-release`, `as-release-bump-version`, `as-release-rubygems-publish`, and `as-release-update-changelog` to the handbook skills reference table.
|
|
14
37
|
- Re-recorded getting-started demo GIF showcasing provider status and sync workflows.
|
|
15
38
|
|
|
16
39
|
### Fixed
|
|
17
|
-
|
|
18
|
-
- Fixed
|
|
40
|
+
|
|
41
|
+
- Fixed broken `[ace-nav](../ace-nav)` cross-link in README -- corrected to `[ace-nav](../ace-support-nav)`.
|
|
42
|
+
- Fixed incorrect `ace-integration-*` package reference in README -- corrected to `ace-handbook-integration-*`.
|
|
19
43
|
|
|
20
44
|
### Changed
|
|
45
|
+
|
|
21
46
|
- Aligned gemspec description wording with summary for consistency.
|
|
22
47
|
- Removed stale `mise` prerequisite from `docs/getting-started.md`.
|
|
23
48
|
- Rewrote demo tape to focus on `ace-handbook status` and `ace-handbook sync --provider pi`.
|
|
@@ -25,23 +50,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
25
50
|
## [0.18.3] - 2026-03-23
|
|
26
51
|
|
|
27
52
|
### Changed
|
|
53
|
+
|
|
28
54
|
- Refreshed `README.md` to the current package layout pattern with quick-link navigation, use-case framing, and normalized section order.
|
|
29
55
|
|
|
30
56
|
## [0.18.2] - 2026-03-22
|
|
31
57
|
|
|
32
58
|
### Changed
|
|
59
|
+
|
|
33
60
|
- Updated `docs/getting-started.md` to remove contradictory `mise exec --` prose and align onboarding guidance with direct `ace-*` command usage.
|
|
34
61
|
- Documented intentional retirement of projected provider `as-idea-capture` and `as-idea-capture-features` skill files after canonical source removal.
|
|
35
62
|
|
|
36
63
|
## [0.18.1] - 2026-03-22
|
|
37
64
|
|
|
38
65
|
### Changed
|
|
66
|
+
|
|
39
67
|
- Remove `mise exec --` wrapper from test fixture strings and canonical skill docs.
|
|
40
68
|
- Document intentional retirement of projected provider `as-idea-capture` and `as-idea-capture-features` skill files after canonical source removal.
|
|
41
69
|
|
|
42
70
|
## [0.18.0] - 2026-03-22
|
|
43
71
|
|
|
44
72
|
### Changed
|
|
73
|
+
|
|
45
74
|
- Reworked `ace-handbook` documentation into a landing-page README with package-focused messaging and links to dedicated docs.
|
|
46
75
|
- Added `docs/getting-started.md`, `docs/usage.md`, and `docs/handbook.md` with tutorial and workflow/skill reference coverage.
|
|
47
76
|
- Added demo assets under `docs/demo/` and aligned examples to the current `ace-nav resolve/list` command pattern.
|
|
@@ -50,181 +79,219 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
50
79
|
## [0.17.1] - 2026-03-21
|
|
51
80
|
|
|
52
81
|
### Added
|
|
82
|
+
|
|
53
83
|
- Add RubyGems publish workflow (`wfi://release/rubygems-publish`) for publishing ACE gems in dependency order with credential verification, conflict detection, and dry-run support.
|
|
54
84
|
- Add `as-release-rubygems-publish` skill for invoking the RubyGems publish workflow.
|
|
55
85
|
|
|
56
86
|
## [0.17.0] - 2026-03-21
|
|
57
87
|
|
|
58
88
|
### Changed
|
|
89
|
+
|
|
59
90
|
- Added initial `TS-HANDBOOK-001` value-gated smoke E2E coverage for `ace-handbook` CLI help and status command contracts.
|
|
60
91
|
|
|
61
92
|
## [0.16.1] - 2026-03-18
|
|
62
93
|
|
|
63
94
|
### Changed
|
|
95
|
+
|
|
64
96
|
- Migrated CLI namespace from `Ace::Core::CLI::*` to `Ace::Support::Cli::*` (ace-support-cli is now the canonical home for CLI infrastructure).
|
|
65
97
|
|
|
66
98
|
|
|
67
99
|
## [0.16.0] - 2026-03-18
|
|
68
100
|
|
|
69
101
|
### Changed
|
|
102
|
+
|
|
70
103
|
- Removed legacy backward-compatibility behavior as part of the 0.10 cleanup release.
|
|
71
104
|
|
|
72
105
|
|
|
73
106
|
## [0.15.9] - 2026-03-18
|
|
74
107
|
|
|
75
108
|
### Fixed
|
|
109
|
+
|
|
76
110
|
- Updated `cli-support-cli.g.md` guide to remove stale `DryCli::` namespace prefix from `VersionCommand` and `HelpCommand` class references.
|
|
77
111
|
|
|
78
112
|
## [0.15.8] - 2026-03-17
|
|
79
113
|
|
|
80
114
|
### Changed
|
|
115
|
+
|
|
81
116
|
- Updated `cli-support-cli.g.md` examples to the current `ace-support-cli` API (`RegistryDsl`, `Runner`, and `coerce_types`).
|
|
82
117
|
- Updated review workflow docs to reflect 15-minute timeout guidance for long PR review runs.
|
|
83
118
|
|
|
84
119
|
## [0.15.7] - 2026-03-15
|
|
85
120
|
|
|
86
121
|
### Changed
|
|
122
|
+
|
|
87
123
|
- Migrated CLI framework from dry-cli to ace-support-cli
|
|
88
124
|
|
|
89
125
|
## [0.15.6] - 2026-03-13
|
|
90
126
|
|
|
91
127
|
### Changed
|
|
128
|
+
|
|
92
129
|
- Updated handbook-owned canonical skills to explicitly run bundled workflows in the current project and execute them end-to-end.
|
|
93
130
|
|
|
94
131
|
### Technical
|
|
132
|
+
|
|
95
133
|
- Refreshed provider sync and status collector regression coverage for the new compact canonical skill execution template.
|
|
96
134
|
|
|
97
135
|
## [0.15.5] - 2026-03-13
|
|
98
136
|
|
|
99
137
|
### Changed
|
|
138
|
+
|
|
100
139
|
- Removed provider-specific skill body rendering so projected provider skills once again apply frontmatter overrides while preserving the canonical skill body unchanged.
|
|
101
140
|
- Updated the canonical `as-release` skill to use the unified arguments / variables / execution structure with explicit workflow-execution guidance.
|
|
102
141
|
- Limited provider-specific forking for `as-release` to Claude frontmatter only.
|
|
103
142
|
|
|
104
143
|
### Technical
|
|
144
|
+
|
|
105
145
|
- Simplified handbook projection coverage to validate frontmatter override projection and canonical body preservation instead of provider-specific body rendering.
|
|
106
146
|
|
|
107
147
|
## [0.15.4] - 2026-03-13
|
|
108
148
|
|
|
109
149
|
### Changed
|
|
150
|
+
|
|
110
151
|
- Strengthened projected workflow skill instructions for Codex delegated execution and forked provider contexts so generated provider skills explicitly load and execute workflows in the current project instead of only reading or summarizing them.
|
|
111
152
|
|
|
112
153
|
### Technical
|
|
154
|
+
|
|
113
155
|
- Added projection regression coverage for strong workflow-execution rendering in both Codex `context: ace-llm` mode and provider `context: fork` mode.
|
|
114
156
|
|
|
115
157
|
## [0.15.3] - 2026-03-13
|
|
116
158
|
|
|
117
159
|
### Changed
|
|
160
|
+
|
|
118
161
|
- Render Codex `ace-llm` skills from canonical frontmatter by deriving uppercase variables from `argument-hint` and generating `## Variables` / `## Instructions` sections for projected Codex skills.
|
|
119
162
|
|
|
120
163
|
### Technical
|
|
164
|
+
|
|
121
165
|
- Added projection regression coverage for `context: ace-llm` rendering and argument-hint-derived Codex variable generation.
|
|
122
166
|
|
|
123
167
|
## [0.15.2] - 2026-03-12
|
|
124
168
|
|
|
125
169
|
### Fixed
|
|
170
|
+
|
|
126
171
|
- Preserved conditional `--sandbox` workflow routing in provider-synced skill projections so generated Claude and Codex skills keep the canonical E2E execute path.
|
|
127
172
|
|
|
128
173
|
### Technical
|
|
174
|
+
|
|
129
175
|
- Added provider-sync regression coverage for conditional workflow bodies in projected skills.
|
|
130
176
|
|
|
131
177
|
## [0.15.1] - 2026-03-12
|
|
132
178
|
|
|
133
179
|
### Changed
|
|
180
|
+
|
|
134
181
|
- Updated handbook README, workflow docs, and guidance to document bundle-first workflow usage and the current handbook structure.
|
|
135
182
|
|
|
136
183
|
## [0.15.0] - 2026-03-12
|
|
137
184
|
|
|
138
185
|
### Added
|
|
186
|
+
|
|
139
187
|
- Added Codex-specific delegated execution metadata to the canonical `as-release-bump-version` and `as-release-update-changelog` skills so the generated Codex skills run in fork context on `gpt-5.3-codex-spark`.
|
|
140
188
|
|
|
141
189
|
## [0.14.1] - 2026-03-12
|
|
142
190
|
|
|
143
191
|
### Technical
|
|
192
|
+
|
|
144
193
|
- Updated provider sync regression coverage to verify provider-specific `context` and `model` overrides on projected git-commit skills and to keep generated provider output free of canonical `integration` metadata.
|
|
145
194
|
|
|
146
195
|
## [0.14.0] - 2026-03-12
|
|
147
196
|
|
|
148
197
|
### Changed
|
|
198
|
+
|
|
149
199
|
- Changed canonical handbook skill inventory to load from registered `skill://` sources via `ace-support-nav` instead of scanning monorepo package directories directly.
|
|
150
200
|
|
|
151
201
|
### Technical
|
|
202
|
+
|
|
152
203
|
- Added nav-backed inventory regression coverage and explicit skill-source registration fixtures for handbook sync/status tests.
|
|
153
204
|
|
|
154
205
|
## [0.13.1] - 2026-03-12
|
|
155
206
|
|
|
156
207
|
### Technical
|
|
208
|
+
|
|
157
209
|
- Added regression coverage for the `.agent/skills` retirement so handbook sync/status changes are exercised against provider-native skill trees only.
|
|
158
210
|
|
|
159
211
|
## [0.13.0] - 2026-03-12
|
|
160
212
|
|
|
161
213
|
### Added
|
|
214
|
+
|
|
162
215
|
- Added canonical skill inventory counts by `source` to `ace-handbook status` output and JSON responses.
|
|
163
216
|
|
|
164
217
|
### Changed
|
|
218
|
+
|
|
165
219
|
- Expanded provider status reporting to show expected, installed, in-sync, outdated, missing, and extra skill counts, including comparisons through symlinked provider directories.
|
|
166
220
|
|
|
167
221
|
## [0.12.0] - 2026-03-10
|
|
168
222
|
|
|
169
223
|
### Added
|
|
224
|
+
|
|
170
225
|
- Added a public `ace-handbook` CLI with `sync` and `status` commands for projecting canonical package skills into provider-native folders.
|
|
171
226
|
- Added provider manifest discovery and sync/status coverage for handbook integrations, including replacement of legacy provider skill symlinks with real provider directories.
|
|
172
227
|
|
|
173
228
|
### Changed
|
|
229
|
+
|
|
174
230
|
- Moved handbook integration execution to `ace-handbook` while provider packages now supply thin provider manifests for projection targets.
|
|
175
231
|
|
|
176
232
|
## [0.11.0] - 2026-03-10
|
|
177
233
|
|
|
178
234
|
### Added
|
|
235
|
+
|
|
179
236
|
- Added canonical handbook-owned skills for handbook management, release workflows, and research/delivery orchestration.
|
|
180
237
|
|
|
181
238
|
|
|
182
239
|
## [0.10.0] - 2026-03-08
|
|
183
240
|
|
|
184
241
|
### Added
|
|
242
|
+
|
|
185
243
|
- New `release/publish` workflow for coordinated multi-package releases that auto-detect modified packages, update package and root changelogs, and finish with one release commit.
|
|
186
244
|
|
|
187
245
|
### Changed
|
|
246
|
+
|
|
188
247
|
- `/as-release` now loads `wfi://release/publish`, and release documentation now points to the canonical workflow path.
|
|
189
248
|
|
|
190
249
|
## [0.9.9] - 2026-03-04
|
|
191
250
|
|
|
192
251
|
### Changed
|
|
252
|
+
|
|
193
253
|
- Update `perform-delivery` workflow PR skill references from `/ace-git-create-pr` to `/ace-github-pr-create`
|
|
194
254
|
|
|
195
255
|
## [0.9.8] - 2026-02-25
|
|
196
256
|
|
|
197
257
|
### Changed
|
|
258
|
+
|
|
198
259
|
- Update `perform-delivery` workflow task lookup guidance to use `ace-task show <ref>` for explicit task selection.
|
|
199
260
|
|
|
200
261
|
## [0.9.7] - 2026-02-22
|
|
201
262
|
|
|
202
263
|
### Technical
|
|
264
|
+
|
|
203
265
|
- Update `ace-bundle project` → `ace-bundle load project` in update-docs workflow
|
|
204
266
|
|
|
205
267
|
## [0.9.6] - 2026-02-22
|
|
206
268
|
|
|
207
269
|
### Changed
|
|
270
|
+
|
|
208
271
|
- Migrate skill naming and invocation references to hyphenated `ace-*` format (no underscores).
|
|
209
272
|
|
|
210
273
|
## [0.9.5] - 2026-02-21
|
|
211
274
|
|
|
212
275
|
### Added
|
|
276
|
+
|
|
213
277
|
- "Redundant computation" root cause category in selfimprove workflow with fix template showing compute-once-pass-explicitly pattern
|
|
214
278
|
|
|
215
279
|
## [0.9.4] - 2026-02-20
|
|
216
280
|
|
|
217
281
|
### Technical
|
|
282
|
+
|
|
218
283
|
- Update /ace:create-pr to /ace:git-create-pr in perform-delivery workflow
|
|
219
284
|
|
|
220
285
|
## [0.9.3] - 2026-02-20
|
|
221
286
|
|
|
222
287
|
### Technical
|
|
288
|
+
|
|
223
289
|
- Update stale wfi:// references in workflow definition guide
|
|
224
290
|
|
|
225
291
|
## [0.9.2] - 2026-02-19
|
|
226
292
|
|
|
227
293
|
### Technical
|
|
294
|
+
|
|
228
295
|
- Namespace workflow instructions into handbook/ subdirectory with updated wfi:// URIs
|
|
229
296
|
- Update skill name references to use namespaced ace:handbook-action format
|
|
230
297
|
|
|
@@ -237,77 +304,97 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
237
304
|
## [0.9.0] - 2026-02-03
|
|
238
305
|
|
|
239
306
|
### Added
|
|
307
|
+
|
|
240
308
|
- Self-improve workflow (`selfimprove.wf.md`) for transforming agent mistakes into system improvements
|
|
241
309
|
|
|
242
310
|
## [0.8.0] - 2026-01-31
|
|
243
311
|
|
|
244
312
|
### Added
|
|
313
|
+
|
|
245
314
|
- Multi-agent research synthesis capabilities (Task 254):
|
|
315
|
+
|
|
246
316
|
- `multi-agent-research.g.md` guide explaining when/how to use parallel agents
|
|
247
317
|
- `research-comparison.template.md` for structured synthesis comparison
|
|
248
318
|
- `parallel-research.wf.md` workflow for setting up parallel agent research
|
|
249
319
|
- `synthesize-research.wf.md` workflow for combining agent outputs
|
|
250
320
|
- `research.wf.md` with single/multi-agent decision criteria
|
|
321
|
+
|
|
251
322
|
- Template protocol source configuration for ace-handbook templates
|
|
252
323
|
|
|
253
324
|
## [0.7.1] - 2026-01-29
|
|
254
325
|
|
|
255
326
|
### Fixed
|
|
327
|
+
|
|
256
328
|
- Refine exit code handling documentation for dry-cli framework with exception-based pattern
|
|
257
329
|
|
|
258
330
|
## [0.7.0] - 2026-01-22
|
|
259
331
|
|
|
260
332
|
### Added
|
|
333
|
+
|
|
261
334
|
- New guides extracted from ace-gems.g.md for better discoverability:
|
|
335
|
+
|
|
262
336
|
- `prompt-caching.g.md` - PromptCacheManager patterns for LLM prompt generation
|
|
263
337
|
- `cli-dry-cli.g.md` - Complete dry-cli framework reference
|
|
264
338
|
- `mono-repo-patterns.g.md` - Mono-repo development patterns and binstubs
|
|
339
|
+
|
|
265
340
|
- Document IO isolation and testing pyramid patterns
|
|
266
341
|
|
|
267
342
|
### Technical
|
|
343
|
+
|
|
268
344
|
- Lower Ruby version requirement to >= 3.2.0
|
|
269
345
|
|
|
270
346
|
## [0.6.0] - 2026-01-18
|
|
271
347
|
|
|
272
348
|
### Added
|
|
349
|
+
|
|
273
350
|
- Add perform-delivery workflow for multi-step delivery tracking with automatic TodoWrite externalization
|
|
274
351
|
|
|
275
352
|
### Technical
|
|
353
|
+
|
|
276
354
|
- Update guides for bundle terminology
|
|
277
355
|
|
|
278
356
|
## [0.5.2] - 2026-01-16
|
|
279
357
|
|
|
280
358
|
### Changed
|
|
359
|
+
|
|
281
360
|
- Rename context: to bundle: keys in configuration files
|
|
282
361
|
|
|
283
362
|
## [0.5.1] - 2026-01-08
|
|
284
363
|
|
|
285
364
|
### Fixed
|
|
365
|
+
|
|
286
366
|
- Fixed `guide://` protocol links in ace-test-runner guides (added `.g` suffix for `.g.md` files)
|
|
287
367
|
- Cross-gem guide:// links now properly resolve to resources with `.g` extension
|
|
288
368
|
|
|
289
369
|
## [0.5.0] - 2026-01-08
|
|
290
370
|
|
|
291
371
|
### Added
|
|
372
|
+
|
|
292
373
|
- Migrated 10 generic guides from dev-handbook to handbook/guides/
|
|
374
|
+
|
|
293
375
|
- ai-agent-integration.g.md, atom-pattern.g.md, changelog.g.md
|
|
294
376
|
- coding-standards.g.md, debug-troubleshooting.g.md, error-handling.g.md
|
|
295
377
|
- performance.g.md, quality-assurance.g.md, strategic-planning.g.md
|
|
378
|
+
|
|
296
379
|
- Migrated 5 meta-guides to handbook/guides/meta/
|
|
380
|
+
|
|
297
381
|
- agents-definition.g.md, guides-definition.g.md, markdown-definition.g.md
|
|
298
382
|
- tools-definition.g.md, workflow-instructions-definition.g.md
|
|
383
|
+
|
|
299
384
|
- Guide subdirectories with language-specific content (ruby, rust, typescript)
|
|
300
385
|
- initialize-project-structure.wf.md workflow for project setup
|
|
301
386
|
- Templates: cookbooks/cookbook.template.md, completed-work-documentation.md
|
|
302
387
|
- Template discovery protocol (.ace-defaults/nav/protocols/tmpl-sources/)
|
|
303
388
|
|
|
304
389
|
### Changed
|
|
390
|
+
|
|
305
391
|
- Consolidates dev-handbook content into ace-handbook gem
|
|
306
392
|
- All development guides now distributed with gem installation
|
|
307
393
|
|
|
308
394
|
## [0.4.0] - 2026-01-03
|
|
309
395
|
|
|
310
396
|
### Added
|
|
397
|
+
|
|
311
398
|
- Guides support with handbook/guides/ directory
|
|
312
399
|
- workflow-context-embedding.g.md guide for embed_document_source pattern
|
|
313
400
|
- Guide discovery protocol (.ace-defaults/nav/protocols/guide-sources/ace-handbook.yml)
|
|
@@ -315,6 +402,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
315
402
|
## [0.3.0] - 2026-01-03
|
|
316
403
|
|
|
317
404
|
### Changed
|
|
405
|
+
|
|
318
406
|
- **BREAKING**: Minimum Ruby version raised to 3.3.0 (was 3.1.0)
|
|
319
407
|
- Standardized gemspec file patterns with deterministic Dir.glob
|
|
320
408
|
- Added MIT LICENSE file
|
|
@@ -328,33 +416,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
328
416
|
## [0.1.0] - 2025-11-05
|
|
329
417
|
|
|
330
418
|
### Added
|
|
419
|
+
|
|
331
420
|
- Initial release of ace-handbook gem as pure workflow package
|
|
332
421
|
- 6 handbook management workflows accessible via wfi:// protocol:
|
|
422
|
+
|
|
333
423
|
- `wfi://manage-guides` - Create and update development guides
|
|
334
424
|
- `wfi://review-guides` - Review guides for quality and consistency
|
|
335
425
|
- `wfi://manage-workflow-instructions` - Create and validate workflow files
|
|
336
426
|
- `wfi://review-workflows` - Review workflow instructions
|
|
337
427
|
- `wfi://manage-agents` - Create and update agent definitions
|
|
338
428
|
- `wfi://update-handbook-docs` - Update handbook README and structure
|
|
429
|
+
|
|
339
430
|
- Path references updated for project-relative usage
|
|
340
431
|
- Complete gem structure following ACE patterns
|
|
341
432
|
- Comprehensive documentation and usage examples
|
|
342
433
|
- Auto-discovery support through ace-nav gem
|
|
343
434
|
|
|
344
435
|
### Changed
|
|
436
|
+
|
|
345
437
|
- Migrated workflows from dev-handbook/.meta/wfi/ to installable gem
|
|
346
438
|
- Updated path references to be project-root relative
|
|
347
439
|
- Removed dev-handbook specific dependencies
|
|
348
440
|
|
|
349
441
|
### Removed
|
|
442
|
+
|
|
350
443
|
- Moved `update-tools-docs.wf.md` to ace-docs package (tools documentation management)
|
|
351
444
|
- Moved `update-integration-claude.wf.md` to ace-integration-claude package (Claude Code integration)
|
|
352
445
|
|
|
353
446
|
### Fixed
|
|
447
|
+
|
|
354
448
|
- Added ace-nav protocol registration (.ace.example/nav/protocols/wfi-sources/ace-handbook.yml)
|
|
355
449
|
- Updated gemspec to include protocol registration files for proper discovery
|
|
356
450
|
|
|
357
451
|
### Technical Details
|
|
452
|
+
|
|
358
453
|
- Pure workflow package with no Ruby runtime dependencies
|
|
359
454
|
- Auto-discovery via ace-nav through handbook/workflow-instructions/ directory
|
|
360
455
|
- Protocol registration enables ace-nav to discover workflows from installed gem
|
data/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
Standardized workflows for creating and managing guides, workflow instructions, and agent definitions.
|
|
5
5
|
|
|
6
|
-
<img src="
|
|
6
|
+
<img src="../docs/brand/AgenticCodingEnvironment.Logo.XS.jpg" alt="ACE Logo" width="480">
|
|
7
7
|
<br><br>
|
|
8
8
|
|
|
9
9
|
<a href="https://rubygems.org/gems/ace-handbook"><img alt="Gem Version" src="https://img.shields.io/gem/v/ace-handbook.svg" /></a>
|
|
@@ -16,6 +16,7 @@ Complete reference for implementing CLI interfaces in ace-* gems using dry-cli.
|
|
|
16
16
|
All ACE CLI gems use dry-cli. See [ADR-023](../../../docs/decisions/ADR-023-dry-cli-framework.md) for decision rationale.
|
|
17
17
|
|
|
18
18
|
**Two patterns:**
|
|
19
|
+
|
|
19
20
|
- **Multi-command**: Subcommand tools (ace-bundle, ace-taskflow)
|
|
20
21
|
- **Single-command**: One-action tools (ace-git-commit, ace-search)
|
|
21
22
|
|
|
@@ -73,6 +74,7 @@ end
|
|
|
73
74
|
```
|
|
74
75
|
|
|
75
76
|
**Exe wrapper:**
|
|
77
|
+
|
|
76
78
|
```ruby
|
|
77
79
|
#!/usr/bin/env ruby
|
|
78
80
|
require "ace/gem"
|
|
@@ -113,6 +115,7 @@ end
|
|
|
113
115
|
```
|
|
114
116
|
|
|
115
117
|
**Exe wrapper:**
|
|
118
|
+
|
|
116
119
|
```ruby
|
|
117
120
|
#!/usr/bin/env ruby
|
|
118
121
|
require "ace/gem"
|
|
@@ -232,6 +235,7 @@ end
|
|
|
232
235
|
```
|
|
233
236
|
|
|
234
237
|
**Exe wrapper catches exceptions:**
|
|
238
|
+
|
|
235
239
|
```ruby
|
|
236
240
|
#!/usr/bin/env ruby
|
|
237
241
|
require "ace/gem"
|
|
@@ -16,6 +16,7 @@ Complete reference for implementing CLI interfaces in ace-* gems using ace-suppo
|
|
|
16
16
|
All ACE CLI gems use ace-support-cli. See [ADR-023](../../../docs/decisions/ADR-023-ace-support-cli-framework.md) for decision rationale.
|
|
17
17
|
|
|
18
18
|
**Two patterns:**
|
|
19
|
+
|
|
19
20
|
- **Multi-command**: Subcommand tools (ace-bundle, ace-taskflow)
|
|
20
21
|
- **Single-command**: One-action tools (ace-git-commit, ace-search)
|
|
21
22
|
|
|
@@ -73,6 +74,7 @@ end
|
|
|
73
74
|
```
|
|
74
75
|
|
|
75
76
|
**Exe wrapper:**
|
|
77
|
+
|
|
76
78
|
```ruby
|
|
77
79
|
#!/usr/bin/env ruby
|
|
78
80
|
require "ace/gem"
|
|
@@ -113,6 +115,7 @@ end
|
|
|
113
115
|
```
|
|
114
116
|
|
|
115
117
|
**Exe wrapper:**
|
|
118
|
+
|
|
116
119
|
```ruby
|
|
117
120
|
#!/usr/bin/env ruby
|
|
118
121
|
require "ace/gem"
|
|
@@ -232,6 +235,7 @@ end
|
|
|
232
235
|
```
|
|
233
236
|
|
|
234
237
|
**Exe wrapper catches exceptions:**
|
|
238
|
+
|
|
235
239
|
```ruby
|
|
236
240
|
#!/usr/bin/env ruby
|
|
237
241
|
require "ace/gem"
|
|
@@ -33,7 +33,7 @@ addition to the generic standards in `../coding-standards.md`.
|
|
|
33
33
|
|
|
34
34
|
## Performance Tips
|
|
35
35
|
|
|
36
|
-
- Prefer `each` over `map` when you don
|
|
36
|
+
- Prefer `each` over `map` when you don't need the new array.
|
|
37
37
|
- Avoid creating unnecessary objects in hot code paths.
|
|
38
38
|
|
|
39
39
|
---
|
|
@@ -22,15 +22,23 @@ in the relevant `dev-taskflow/` directory or linked from the `docs/blueprint.md`
|
|
|
22
22
|
## General Principles
|
|
23
23
|
|
|
24
24
|
- **Clarity & Readability:** Write code that is easy for others (and your future self) to understand. Use
|
|
25
|
+
|
|
25
26
|
meaningful variable names, keep functions/methods short and focused, and add comments where logic is
|
|
26
27
|
complex or non-obvious.
|
|
28
|
+
|
|
27
29
|
- **Consistency:** Follow established patterns and conventions within the project. If using a style guide tool
|
|
30
|
+
|
|
28
31
|
(like StandardRB, RuboCop), adhere to its rules.
|
|
32
|
+
|
|
29
33
|
- **Simplicity (KISS):** Avoid unnecessary complexity. Prefer straightforward solutions unless a more complex
|
|
34
|
+
|
|
30
35
|
approach offers significant, justifiable benefits (e.g., performance).
|
|
36
|
+
|
|
31
37
|
- **Don\'t Repeat Yourself (DRY):** Abstract common logic into reusable functions, methods, or classes.
|
|
32
38
|
- **Modularity:** Design components with clear responsibilities and well-defined interfaces. Aim for loose
|
|
39
|
+
|
|
33
40
|
coupling and high cohesion.
|
|
41
|
+
|
|
34
42
|
- **Testability:** Write code that is easy to test. Use dependency injection and avoid tight coupling to
|
|
35
43
|
|
|
36
44
|
## Language-Specific Coding Standards
|
|
@@ -45,9 +53,12 @@ Please refer to the relevant guide for your language:
|
|
|
45
53
|
|
|
46
54
|
- **Indentation:** Use consistent indentation (e.g., 2 spaces for Ruby).
|
|
47
55
|
- **Line Length:** Adhere to a reasonable line length limit (e.g., 100-120 characters) to improve
|
|
56
|
+
|
|
48
57
|
readability.
|
|
58
|
+
|
|
49
59
|
- **Whitespace:** Use whitespace effectively to separate logical blocks of code.
|
|
50
60
|
- **Tooling:** Utilize automated formatters and linters (e.g., StandardRB, Prettier) to enforce
|
|
61
|
+
|
|
51
62
|
consistency. Configure these tools via project configuration files (e.g., `.standard.yml`, `.prettierrc`).
|
|
52
63
|
|
|
53
64
|
## Error Handling
|
|
@@ -75,6 +86,7 @@ Please refer to the relevant guide for your language:
|
|
|
75
86
|
|
|
76
87
|
- Follow a logical directory structure (e.g., separating library code, tests, configuration, documentation).
|
|
77
88
|
- Use clear and consistent file naming conventions.
|
|
89
|
+
|
|
78
90
|
Refer to the project's `docs/blueprint.md` for the specific structure.
|
|
79
91
|
|
|
80
92
|
## AI-Assisted Development Collaboration
|
|
@@ -83,26 +95,41 @@ When working with AI coding agents (like Cursor, Claude, etc.), treat them as co
|
|
|
83
95
|
to a junior developer needing clear guidance.
|
|
84
96
|
|
|
85
97
|
- **Plan Before Prompting:** Thoroughly plan the task, including outlining steps, defining requirements, and
|
|
98
|
+
|
|
86
99
|
identifying relevant context *before* asking the AI to generate or modify code. This aligns with the
|
|
87
100
|
"Slow Vibe Coding" principle mentioned in Project Management.
|
|
101
|
+
|
|
88
102
|
- **Provide Context:** Give the AI sufficient context, including relevant code snippets, project structure
|
|
103
|
+
|
|
89
104
|
(`docs/blueprint.md`), architecture (`docs/architecture.md`), existing patterns, and the
|
|
90
105
|
specific task definition (`.md` file within `dev-taskflow`).
|
|
106
|
+
|
|
91
107
|
- **Use Specific, Concise Instructions:** Avoid vague requests. Break down complex tasks into smaller,
|
|
108
|
+
|
|
92
109
|
well-defined steps. Use clear action verbs and specify the desired outcome. Consider using "prompt hygiene"
|
|
93
110
|
like "ONLY IMPLEMENT EXACTLY THIS STEP" for focused changes.
|
|
111
|
+
|
|
94
112
|
- **Structured Prompts:** Structure prompts clearly, defining the AI\'s role, the objective, step-by-step instructions,
|
|
113
|
+
|
|
95
114
|
and the desired output format (XML is often preferred by models like GPT-4.1). Include examples (few-shot learning)
|
|
96
115
|
where appropriate.
|
|
116
|
+
|
|
97
117
|
- **Review Rigorously:** Review AI-generated code with the same scrutiny as human-written code. Check for
|
|
118
|
+
|
|
98
119
|
correctness, adherence to standards, edge cases, security, and performance implications. Do not blindly
|
|
99
120
|
trust AI output.
|
|
121
|
+
|
|
100
122
|
- **Iterate and Refine:** Expect to iterate. Provide constructive feedback on the AI\'s output to guide it
|
|
123
|
+
|
|
101
124
|
towards the desired solution. Ask for explanations of its logic to learn and verify understanding.
|
|
125
|
+
|
|
102
126
|
- **Leverage Strengths:** Use AI for tasks it excels at (e.g., boilerplate code, implementing well-defined
|
|
127
|
+
|
|
103
128
|
algorithms, refactoring based on clear rules) but rely on human oversight for complex design decisions
|
|
104
129
|
and architectural planning.
|
|
130
|
+
|
|
105
131
|
- **Avoid "Hacky" Prompts:** Modern models respond better to clear instructions than tricks like excessive
|
|
132
|
+
|
|
106
133
|
capitalization or emotional appeals.
|
|
107
134
|
|
|
108
135
|
Refer to the [Project Management Guide](guide://project-management) for how AI collaboration fits
|
|
@@ -16,7 +16,7 @@ debugging to seeking help.
|
|
|
16
16
|
|
|
17
17
|
| Step | What to do | Why |
|
|
18
18
|
|------|------------|-----|
|
|
19
|
-
| **1 Understand the system** | Skim docs/architecture first | You can
|
|
19
|
+
| **1 Understand the system** | Skim docs/architecture first | You can't debug what you don't grasp. |
|
|
20
20
|
| **2 Make it fail on demand** | Reproduce the bug and minimise the input or scenario | Gives you a quick feedback loop & future test. |
|
|
21
21
|
| **3 Collect evidence** | Read stack traces, logs, error codes | Surface clues without touching code. |
|
|
22
22
|
| **4 Check recent changes/config** | Roll back toggles, feature flags, deployments | Regressions are usually fresh. |
|
|
@@ -30,13 +30,20 @@ debugging to seeking help.
|
|
|
30
30
|
## Elaborations on Key Steps
|
|
31
31
|
|
|
32
32
|
* **Step 2: Make it fail on demand:** This is crucial for effective testing. Aim for the *simplest possible*
|
|
33
|
+
|
|
33
34
|
reproducible case. This often forms the basis of a new regression test (see Step 8).
|
|
35
|
+
|
|
34
36
|
* **Step 3 & 4: Collect evidence & Check recent changes:** Don't underestimate logs, configuration files, and
|
|
37
|
+
|
|
35
38
|
recent commits (`git log`, `git blame`). Many issues are regressions introduced by recent changes.
|
|
39
|
+
|
|
36
40
|
* **Step 8: Validate & Regress-Test:** After applying a fix, *always* run the minimal failing case you created in
|
|
41
|
+
|
|
37
42
|
Step 2 to confirm the specific issue is resolved. Then, run the broader test suite (e.g., `bin/rspec`, `npm test`)
|
|
38
43
|
to check for unintended side-effects. Refer to the [Testing Guidelines Guide](testing.g.md) for more details.
|
|
44
|
+
|
|
39
45
|
* **Step 10: Escalate or Rubber Duck:** If you're stuck after diligently following the steps:
|
|
46
|
+
|
|
40
47
|
* **Rubber Ducking:** Explain the problem out loud (to yourself, a pet, or an inanimate object). This often
|
|
41
48
|
clarifies your thinking.
|
|
42
49
|
* **AI Assistance:** Consult an AI agent. Use structured prompts, providing the context (code, error, steps taken).
|
|
@@ -48,8 +55,11 @@ debugging to seeking help.
|
|
|
48
55
|
## Utilizing Documentation and Research
|
|
49
56
|
|
|
50
57
|
* **Internal Docs:** Before extensive debugging, always check project-specific documentation (`README.md`,
|
|
58
|
+
|
|
51
59
|
architecture diagrams in project docs, specific guides via `guide://` protocol).
|
|
60
|
+
|
|
52
61
|
* **External Research:** Use search engines effectively. Formulate precise queries including error messages,
|
|
62
|
+
|
|
53
63
|
technology names, and library versions.
|
|
54
64
|
|
|
55
65
|
## Language-Specific Considerations
|