ace-handbook 0.23.5 → 0.27.4
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/.ace-defaults/nav/protocols/cookbook-sources/ace-handbook.yml +13 -0
- data/CHANGELOG.md +81 -1
- data/README.md +12 -5
- data/handbook/cookbooks/setup-starting-a-multi-ruby-gem-monorepo-with-ace.cookbook.md +151 -0
- data/handbook/cookbooks/setup-starting-an-astro-project-with-ace.cookbook.md +180 -0
- data/handbook/guides/cli-dry-cli.g.md +2 -2
- data/handbook/guides/cli-support-cli.g.md +2 -2
- data/handbook/skills/as-handbook-manage-cookbooks/SKILL.md +35 -0
- data/handbook/skills/as-handbook-review-cookbooks/SKILL.md +32 -0
- data/handbook/skills/as-release-rubygems-publish/SKILL.md +2 -2
- data/handbook/templates/cookbooks/cookbook.template.md +29 -13
- data/handbook/workflow-instructions/handbook/manage-cookbooks.wf.md +117 -0
- data/handbook/workflow-instructions/handbook/perform-delivery.wf.md +1 -1
- data/handbook/workflow-instructions/handbook/review-cookbooks.wf.md +91 -0
- data/lib/ace/handbook/organisms/skill_inventory.rb +70 -10
- data/lib/ace/handbook/version.rb +1 -1
- metadata +9 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: de6c88b47a7fafffa19ef76352db0569c3fa5b3139a661b925616d1cbc7b0774
|
|
4
|
+
data.tar.gz: d6e990ead6a32aebb44a20a630d422dd704d88c2ab6bebb17d6a1e32a593476d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bd5418f90557c7666854e07450cabc08a572a6a8b73129a100f17be8e2154b6bf4ed7414aa8986cfff0163ab9367566e388478728093f8e91ef715991438b7e1
|
|
7
|
+
data.tar.gz: 2f15096be8f24d52ea63116ad6e380130a924f823283732941ff3bed8581c0d3e3cf8c86a23455a1f9e516621d9e08db71fe20be340826e21cc6b828502f8825
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
# Cookbook Sources Protocol Configuration for ace-handbook gem
|
|
3
|
+
# This enables cookbook discovery from handbook-owned cookbook assets
|
|
4
|
+
|
|
5
|
+
name: ace-handbook
|
|
6
|
+
type: gem
|
|
7
|
+
description: Cookbooks from ace-handbook gem
|
|
8
|
+
priority: 10
|
|
9
|
+
|
|
10
|
+
config:
|
|
11
|
+
relative_path: handbook/cookbooks
|
|
12
|
+
pattern: "*.cookbook.md"
|
|
13
|
+
enabled: true
|
data/CHANGELOG.md
CHANGED
|
@@ -7,10 +7,90 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
+
## [0.27.4] - 2026-04-16
|
|
11
|
+
|
|
12
|
+
### Technical
|
|
13
|
+
- Updated `TS-HANDBOOK-001` sandbox setup to source `mise.toml` from `${ACE_E2E_SOURCE_ROOT:-$PROJECT_ROOT_PATH}` so handbook smoke flows stay aligned with the shared read-only source-root contract.
|
|
14
|
+
|
|
15
|
+
## [0.27.3] - 2026-04-15
|
|
16
|
+
|
|
17
|
+
### Fixed
|
|
18
|
+
- Corrected `TS-HANDBOOK-002` setup to copy `mise.toml` from `${ACE_E2E_SOURCE_ROOT:-$PROJECT_ROOT_PATH}` so sandboxed E2E runs load source-root tooling consistently.
|
|
19
|
+
|
|
20
|
+
### Changed
|
|
21
|
+
- Corrected release-proof command references to use positional `ace-test-e2e ace-monorepo-e2e TS-MONO-001` invocation.
|
|
22
|
+
|
|
23
|
+
## [0.27.2] - 2026-04-15
|
|
24
|
+
|
|
25
|
+
### Changed
|
|
26
|
+
- Updated RubyGems propagation proof docs to use the supported positional `ace-test-e2e ace-monorepo-e2e TS-MONO-001` invocation and current scenario path.
|
|
27
|
+
|
|
28
|
+
## [0.27.0] - 2026-04-14
|
|
29
|
+
|
|
30
|
+
### Changed
|
|
31
|
+
- Rewrote `ace-handbook` E2E coverage to public-surface goal style by retaining the CLI smoke flow and adding `TS-HANDBOOK-002` sync/provider-error behavior scenarios.
|
|
32
|
+
- Tightened `TS-HANDBOOK-001` verifier contracts to prioritize user-visible output and enforce stronger status JSON shape expectations.
|
|
33
|
+
|
|
34
|
+
### Technical
|
|
35
|
+
- Updated usage guidance with explicit `sync --provider` and unknown-provider error-path examples aligned to the E2E public contract.
|
|
36
|
+
|
|
37
|
+
## [0.26.2] - 2026-04-13
|
|
38
|
+
|
|
39
|
+
### Changed
|
|
40
|
+
- Documented `cookbook://` wildcard deduplication semantics in usage guidance, including canonical-path behavior and priority-preserving source selection notes.
|
|
41
|
+
|
|
42
|
+
## [0.26.1] - 2026-04-13
|
|
43
|
+
|
|
44
|
+
### Changed
|
|
45
|
+
- Completed the batch i05 migration follow-through for this package and aligned it with the restarted `fast` / `feat` / `e2e` verification model.
|
|
46
|
+
|
|
47
|
+
### Technical
|
|
48
|
+
- Included in the coordinated assignment-driven patch release for batch i05 package updates.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
## [0.26.0] - 2026-04-12
|
|
52
|
+
|
|
53
|
+
### Changed
|
|
54
|
+
- Migrated `ace-handbook` package tests to the `fast` / `feat` / `e2e` contract by moving deterministic suites under `test/fast`, retaining workflow-value CLI smoke E2E coverage, and aligning scenario metadata with the new deterministic paths.
|
|
55
|
+
- Updated package docs (`README`, getting-started, usage) to teach the `ace-test ace-handbook`, optional `ace-test ace-handbook feat`, `ace-test ace-handbook all`, and `ace-test-e2e ace-handbook` verification contract.
|
|
56
|
+
|
|
57
|
+
## [0.25.4] - 2026-04-10
|
|
58
|
+
|
|
59
|
+
### Technical
|
|
60
|
+
- Updated handbook docs and cookbook guidance to point at the restarted E2E testing flows and current release-proof references.
|
|
61
|
+
|
|
62
|
+
## [0.25.3] - 2026-04-05
|
|
63
|
+
|
|
64
|
+
### Fixed
|
|
65
|
+
- Scoped canonical skill inventory discovery to in-project defaults and explicitly registered external sources so status and sync no longer pick up ambient installed gems.
|
|
66
|
+
|
|
67
|
+
## [0.25.2] - 2026-04-01
|
|
68
|
+
|
|
69
|
+
### Changed
|
|
70
|
+
- Updated cookbook management/review workflows to embed canonical cookbook standards and storage-path guidance directly, keeping the workflows self-contained.
|
|
71
|
+
- Clarified cookbook path standards by explicitly distinguishing package-owned cookbooks (`ace-handbook/handbook/cookbooks/`) from project-local overlays (`.ace-handbook/cookbooks/`) in workflow/docs references.
|
|
72
|
+
|
|
73
|
+
## [0.25.1] - 2026-04-01
|
|
74
|
+
|
|
75
|
+
### Fixed
|
|
76
|
+
- Corrected Astro cookbook setup commands to reference supported `ace-handbook` CLI behavior (`sync` / `status` flow), removing obsolete `ace-handbook init` guidance.
|
|
77
|
+
|
|
78
|
+
### Changed
|
|
79
|
+
- Added `.ace-handbook/cookbooks` to usage docs and standardized cookbook-review skill `argument-hint` metadata formatting.
|
|
80
|
+
|
|
81
|
+
## [0.25.0] - 2026-04-01
|
|
82
|
+
|
|
83
|
+
### Added
|
|
84
|
+
- Added cookbook-first handbook surface with `wfi://handbook/manage-cookbooks` and `wfi://handbook/review-cookbooks` workflows plus canonical cookbook skills (`as-handbook-manage-cookbooks`, `as-handbook-review-cookbooks`) and provider projections.
|
|
85
|
+
- Added canonical handbook-owned cookbook examples for Astro project setup and multi-ruby-gem monorepo setup, including explicit provenance and downstream propagation guidance.
|
|
86
|
+
|
|
87
|
+
### Changed
|
|
88
|
+
- Updated README, handbook/usage references, and cookbook template standards to treat `.cookbook.md` as a first-class handbook asset with explicit provenance and concise propagation guidance.
|
|
89
|
+
|
|
10
90
|
## [0.23.5] - 2026-03-31
|
|
11
91
|
|
|
12
92
|
### Changed
|
|
13
|
-
- Replaced `wfi://release/rubygems-verify-install` workflow with E2E scenario `TS-MONO-001-rubygems-install` in `ace-monorepo-e2e/`. Updated all skill and doc references to use `ace-test-e2e ace-monorepo-e2e
|
|
93
|
+
- Replaced `wfi://release/rubygems-verify-install` workflow with E2E scenario `TS-MONO-001-rubygems-install` in `ace-monorepo-e2e/`. Updated all skill and doc references to use `ace-test-e2e ace-monorepo-e2e TS-MONO-001`.
|
|
14
94
|
|
|
15
95
|
## [0.23.4] - 2026-03-31
|
|
16
96
|
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<div align="center">
|
|
2
2
|
<h1> ACE - Handbook </h1>
|
|
3
3
|
|
|
4
|
-
Standardized workflows for creating and managing guides, workflow instructions, and agent definitions.
|
|
4
|
+
Standardized workflows for creating and managing guides, cookbooks, workflow instructions, and agent definitions.
|
|
5
5
|
|
|
6
6
|
<img src="../docs/brand/AgenticCodingEnvironment.Logo.XS.jpg" alt="ACE Logo" width="480">
|
|
7
7
|
<br><br>
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|

|
|
20
20
|
|
|
21
|
-
`ace-handbook` gives ACE teams a shared way to author, review, and maintain handbook assets with consistent quality gates and repeatable delivery workflows. It covers guides (`.g.md`), workflow instructions (`.wf.md`), and agent definitions (`.ag.md`).
|
|
21
|
+
`ace-handbook` gives ACE teams a shared way to author, review, and maintain handbook assets with consistent quality gates and repeatable delivery workflows. It covers guides (`.g.md`), cookbooks (`.cookbook.md`), workflow instructions (`.wf.md`), and agent definitions (`.ag.md`).
|
|
22
22
|
|
|
23
23
|
## How It Works
|
|
24
24
|
|
|
@@ -28,9 +28,9 @@
|
|
|
28
28
|
|
|
29
29
|
## Use Cases
|
|
30
30
|
|
|
31
|
-
**Author handbook assets with consistent structure** - use `/as-handbook-manage-guides`, `/as-handbook-manage-workflows`, and `/as-handbook-manage-agents` to create and update guides, workflow instructions, and agent definitions with package workflows.
|
|
31
|
+
**Author handbook assets with consistent structure** - use `/as-handbook-manage-guides`, `/as-handbook-manage-cookbooks`, `/as-handbook-manage-workflows`, and `/as-handbook-manage-agents` to create and update guides, cookbooks, workflow instructions, and agent definitions with package workflows.
|
|
32
32
|
|
|
33
|
-
**Review handbook content before publishing** - run `/as-handbook-review-guides
|
|
33
|
+
**Review handbook content before publishing** - run `/as-handbook-review-guides`, `/as-handbook-review-cookbooks`, and `/as-handbook-review-workflows` to catch clarity, formatting, and process issues before updates propagate to integrations.
|
|
34
34
|
|
|
35
35
|
**Coordinate larger handbook deliveries** - use `/as-handbook-update-docs` to plan, execute, and synthesize multi-step documentation changes across package handbook assets.
|
|
36
36
|
|
|
@@ -38,7 +38,14 @@
|
|
|
38
38
|
|
|
39
39
|
**Sync and inspect provider integrations** - run `ace-handbook sync` to project canonical skills into provider-native folders and `ace-handbook status` to check integration health across all configured providers.
|
|
40
40
|
|
|
41
|
-
**Extend handbook content in normal projects** - put project-specific workflows, guides, templates, and skills under `.ace-handbook/` and discover them with protocol URLs (`wfi://`, `guide://`, `tmpl://`, `skill://`). See [Usage Guide](docs/usage.md) for path conventions.
|
|
41
|
+
**Extend handbook content in normal projects** - put project-specific workflows, guides, cookbooks, templates, and skills under `.ace-handbook/` and discover them with protocol URLs (`wfi://`, `guide://`, `cookbook://`, `tmpl://`, `skill://`). See [Usage Guide](docs/usage.md) for path conventions.
|
|
42
|
+
|
|
43
|
+
## Testing
|
|
44
|
+
|
|
45
|
+
- `ace-test ace-handbook` runs the deterministic fast suite (`test/fast`).
|
|
46
|
+
- `ace-test ace-handbook feat` runs deterministic feature tests (`test/feat`) when present.
|
|
47
|
+
- `ace-test ace-handbook all` runs all deterministic layers for the package.
|
|
48
|
+
- `ace-test-e2e ace-handbook` runs retained workflow scenarios under `test/e2e`.
|
|
42
49
|
|
|
43
50
|
---
|
|
44
51
|
[Getting Started](docs/getting-started.md) | [Usage Guide](docs/usage.md) | [Handbook - Skills, Agents, Templates](docs/handbook.md) | Part of [ACE](https://github.com/cs3b/ace)
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
# Setup Cookbook: Starting a Multi Ruby Gem Monorepo with ACE
|
|
2
|
+
|
|
3
|
+
**Created**: 2026-04-01
|
|
4
|
+
**Last Updated**: 2026-04-10
|
|
5
|
+
**Category**: setup
|
|
6
|
+
**Audience**: intermediate
|
|
7
|
+
**Estimated Time**: 2-4 hours
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
|
|
11
|
+
Start a new Ruby multi-package monorepo using ACE patterns for package structure, shared defaults, handbook integration, and monorepo-level verification.
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
This cookbook distills monorepo setup patterns from ACE package conventions and cross-cutting E2E quickstart verification work, then turns them into a reusable sequence for new repositories.
|
|
16
|
+
|
|
17
|
+
## Source Provenance
|
|
18
|
+
|
|
19
|
+
- Source workflows/guides/docs:
|
|
20
|
+
- `docs/ace-gems.g.md`
|
|
21
|
+
- `ace-monorepo-e2e/README.md`
|
|
22
|
+
- `.ace-retros/8quwjc-monorepo-e2e-quickstart-verification/8quwjc-monorepo-e2e-quickstart-verification.retro.md`
|
|
23
|
+
- Validation evidence (commands, reports, or artifacts):
|
|
24
|
+
- `ace-test-e2e ace-monorepo-e2e TS-MONO-001`
|
|
25
|
+
- `ace-test-e2e ace-monorepo-e2e TS-MONO-002`
|
|
26
|
+
- `ace-nav resolve cookbook://setup-starting-a-multi-ruby-gem-monorepo-with-ace`
|
|
27
|
+
- Last source verification date: 2026-04-01
|
|
28
|
+
|
|
29
|
+
## Propagation Notes
|
|
30
|
+
|
|
31
|
+
- Documentation updates to apply:
|
|
32
|
+
- Add one monorepo quickstart page that covers prerequisites, workspace bootstrap, and E2E smoke checks.
|
|
33
|
+
- Add a short troubleshooting section for permission and timeout pitfalls during E2E runs.
|
|
34
|
+
- Agent guidance updates to apply:
|
|
35
|
+
- Add concise rules only: "use `ace-test` (not bundle exec)", "run `ace-config init` + `ace-handbook sync` before nav/bundle checks", and "scope E2E scenarios to monorepo-level concerns".
|
|
36
|
+
- Summary-only propagation target notes (do not copy full cookbook body):
|
|
37
|
+
- `README.md`
|
|
38
|
+
- `docs/quick-start.md`
|
|
39
|
+
- `AGENTS.md`
|
|
40
|
+
|
|
41
|
+
## Steps
|
|
42
|
+
|
|
43
|
+
### Step 1: Scaffold monorepo package layout
|
|
44
|
+
|
|
45
|
+
**Objective**: Establish consistent gem/package boundaries and shared conventions.
|
|
46
|
+
|
|
47
|
+
**Commands/Actions:**
|
|
48
|
+
|
|
49
|
+
1. Create packages with `ace-*`, `ace-support-*`, and integration naming patterns from `docs/ace-gems.g.md`.
|
|
50
|
+
2. Include required defaults and handbook directories in each owned package.
|
|
51
|
+
3. Use root-level dependency management for the repository.
|
|
52
|
+
|
|
53
|
+
**Validation:**
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
rg --files | rg "\.ace-defaults/.*/config\.yml"
|
|
57
|
+
rg --files | rg "handbook/"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Step 2: Initialize local ACE configuration for repository tooling
|
|
61
|
+
|
|
62
|
+
**Objective**: Ensure discovery and bundle protocols work in a fresh workspace.
|
|
63
|
+
|
|
64
|
+
**Commands/Actions:**
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
ace-config init
|
|
68
|
+
ace-handbook sync
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
**Validation:**
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
ace-nav list 'wfi://*'
|
|
75
|
+
ace-bundle project
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Step 3: Add monorepo-level E2E scenario container
|
|
79
|
+
|
|
80
|
+
**Objective**: Keep cross-package verification separate from any single gem package.
|
|
81
|
+
|
|
82
|
+
**Commands/Actions:**
|
|
83
|
+
|
|
84
|
+
1. Create `ace-monorepo-e2e/test-e2e/scenarios/TS-*/scenario.yml` entries for repository-wide behaviors.
|
|
85
|
+
2. Use one scenario for install verification and one for quickstart/docs validation.
|
|
86
|
+
3. Keep per-package scenarios in their package folders; keep only cross-cutting cases here.
|
|
87
|
+
|
|
88
|
+
**Validation:**
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
ace-test-e2e ace-monorepo-e2e
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Step 4: Verify quickstart and install paths under realistic conditions
|
|
95
|
+
|
|
96
|
+
**Objective**: Confirm documented setup paths work in clean environments.
|
|
97
|
+
|
|
98
|
+
**Commands/Actions:**
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
ace-test-e2e ace-monorepo-e2e TS-MONO-001
|
|
102
|
+
ace-test-e2e ace-monorepo-e2e TS-MONO-002
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
If runs are network-heavy, raise timeout budgets deliberately and record the reason in scenario docs.
|
|
106
|
+
|
|
107
|
+
**Validation:**
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
ace-test-e2e-suite --tags quickstart
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Step 5: Document guardrails learned from verification
|
|
114
|
+
|
|
115
|
+
**Objective**: Prevent repeated setup failures for new contributors.
|
|
116
|
+
|
|
117
|
+
**Commands/Actions:**
|
|
118
|
+
|
|
119
|
+
Document these defaults in repo docs and concise agent guidance:
|
|
120
|
+
|
|
121
|
+
- Use provider modes that include required permission handling for agent-run E2E.
|
|
122
|
+
- Do not classify operational release steps as E2E scenarios; keep E2E focused on verification behavior.
|
|
123
|
+
- Keep scenario scope tight; avoid adding unrelated package-specific tests without explicit need.
|
|
124
|
+
|
|
125
|
+
**Validation:**
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
rg -n "ace-config init|ace-handbook sync|ace-test-e2e" README.md docs AGENTS.md
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
## Validation & Testing
|
|
132
|
+
|
|
133
|
+
### Final Validation Steps
|
|
134
|
+
|
|
135
|
+
1. Verify cookbook resolves through protocol:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
ace-nav resolve cookbook://setup-starting-a-multi-ruby-gem-monorepo-with-ace
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
2. Verify monorepo scenarios are runnable:
|
|
142
|
+
|
|
143
|
+
```bash
|
|
144
|
+
ace-test-e2e ace-monorepo-e2e
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
### Success Criteria
|
|
148
|
+
|
|
149
|
+
- [x] Monorepo setup sequence is reusable and action-first.
|
|
150
|
+
- [x] Provenance references real project artifacts and verification evidence.
|
|
151
|
+
- [x] Propagation guidance is concise and summary-only.
|
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
# Setup Cookbook: Starting an Astro Project with ACE
|
|
2
|
+
|
|
3
|
+
**Created**: 2026-04-01
|
|
4
|
+
**Last Updated**: 2026-04-01
|
|
5
|
+
**Category**: setup
|
|
6
|
+
**Audience**: intermediate
|
|
7
|
+
**Estimated Time**: 45-90 minutes
|
|
8
|
+
|
|
9
|
+
## Purpose
|
|
10
|
+
|
|
11
|
+
Bootstrap a new Astro project with ACE workflow tooling and assignment sequencing that avoids common rework and deployment blockers.
|
|
12
|
+
|
|
13
|
+
## Overview
|
|
14
|
+
|
|
15
|
+
This cookbook captures the proven ordering and operating pattern from a completed Astro + Tailwind + Firebase project, then reframes it as reusable setup guidance.
|
|
16
|
+
|
|
17
|
+
## Source Provenance
|
|
18
|
+
|
|
19
|
+
- Source workflows/guides/docs:
|
|
20
|
+
- `.ace-tasks/8qs.t.x2b-migrate-cookbook-ownership-to-ace/2-seed-handbook-with-canonical-cookbook/astro-project-with-ace.input.md`
|
|
21
|
+
- `wfi://assign/create`
|
|
22
|
+
- `wfi://assign/drive`
|
|
23
|
+
- Validation evidence (commands, reports, or artifacts):
|
|
24
|
+
- `ace-bundle wfi://assign/create`
|
|
25
|
+
- `ace-bundle wfi://assign/drive`
|
|
26
|
+
- `ace-nav resolve cookbook://setup-starting-an-astro-project-with-ace`
|
|
27
|
+
- Last source verification date: 2026-04-01
|
|
28
|
+
|
|
29
|
+
## Propagation Notes
|
|
30
|
+
|
|
31
|
+
- Documentation updates to apply:
|
|
32
|
+
- Add a short project quickstart section for Astro prerequisites and deployment caveats.
|
|
33
|
+
- Add a mobile-browser gotchas section only if those issues were observed in that project.
|
|
34
|
+
- Agent guidance updates to apply:
|
|
35
|
+
- Add concise rules only: "design tokens first", "mark interactive cloud auth tasks manual", "run 2 review cycles for static-site MVP work".
|
|
36
|
+
- Summary-only propagation target notes (do not copy full cookbook body):
|
|
37
|
+
- `README.md`
|
|
38
|
+
- `CLAUDE.md`
|
|
39
|
+
- `AGENTS.md`
|
|
40
|
+
|
|
41
|
+
## Steps
|
|
42
|
+
|
|
43
|
+
### Step 1: Initialize Astro and styling baseline
|
|
44
|
+
|
|
45
|
+
**Objective**: Create a clean Astro project with Tailwind wired into the build.
|
|
46
|
+
|
|
47
|
+
**Commands/Actions:**
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm create astro@latest -- --template minimal
|
|
51
|
+
npm install tailwindcss @tailwindcss/vite
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Update `astro.config.mjs` and global styles:
|
|
55
|
+
|
|
56
|
+
```js
|
|
57
|
+
import { defineConfig } from 'astro/config';
|
|
58
|
+
import tailwindcss from '@tailwindcss/vite';
|
|
59
|
+
|
|
60
|
+
export default defineConfig({
|
|
61
|
+
vite: { plugins: [tailwindcss()] }
|
|
62
|
+
});
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
```css
|
|
66
|
+
@import "tailwindcss";
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
**Validation:**
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npm run build
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Step 2: Initialize ACE and project guidance
|
|
76
|
+
|
|
77
|
+
**Objective**: Add handbook-aware workflow scaffolding before task execution.
|
|
78
|
+
|
|
79
|
+
**Commands/Actions:**
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
ace-handbook sync
|
|
83
|
+
ace-nav list 'wfi://handbook/*'
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Create concise project-specific rules in `CLAUDE.md` and `AGENTS.md` for commit scope, design system references, and immutable project facts.
|
|
87
|
+
|
|
88
|
+
**Validation:**
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
ace-bundle project
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Step 3: Plan task sequence with design tokens first
|
|
95
|
+
|
|
96
|
+
**Objective**: Prevent styling drift and reduce component rework.
|
|
97
|
+
|
|
98
|
+
**Commands/Actions:**
|
|
99
|
+
|
|
100
|
+
1. Create the design-token task first.
|
|
101
|
+
2. Add component/layout tasks after token decisions are fixed.
|
|
102
|
+
3. Mark interactive authentication steps as manual and outside fork execution.
|
|
103
|
+
|
|
104
|
+
Recommended sequence:
|
|
105
|
+
|
|
106
|
+
1. Design tokens and global styles
|
|
107
|
+
2. Header/navigation
|
|
108
|
+
3. Hero section
|
|
109
|
+
4. Content sections
|
|
110
|
+
5. Contact/CTA
|
|
111
|
+
6. Footer and floating CTA
|
|
112
|
+
7. Image processing
|
|
113
|
+
8. Hosting/deploy (manual)
|
|
114
|
+
|
|
115
|
+
**Validation:**
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
ace-task list --status pending
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Step 4: Create and drive assignment
|
|
122
|
+
|
|
123
|
+
**Objective**: Execute planned work with stable review depth and clear boundaries.
|
|
124
|
+
|
|
125
|
+
**Commands/Actions:**
|
|
126
|
+
|
|
127
|
+
```bash
|
|
128
|
+
ace-assign create work-on-task --taskrefs <task-refs>
|
|
129
|
+
ace-assign drive
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Execution recommendations for Astro/static-site initial builds:
|
|
133
|
+
|
|
134
|
+
- Use 2 review cycles (`valid`, `fit`), skip `shine`.
|
|
135
|
+
- Run sequential fork execution unless sections are truly independent.
|
|
136
|
+
- Keep deployment/auth tasks manual.
|
|
137
|
+
|
|
138
|
+
**Validation:**
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
ace-assign status
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Step 5: Run post-build polish and release checks
|
|
145
|
+
|
|
146
|
+
**Objective**: Catch real browser/device issues before release.
|
|
147
|
+
|
|
148
|
+
**Commands/Actions:**
|
|
149
|
+
|
|
150
|
+
- Verify mobile behavior, especially iOS Safari menu/scroll handling.
|
|
151
|
+
- Verify social preview metadata and non-WebP OG image output.
|
|
152
|
+
|
|
153
|
+
**Validation:**
|
|
154
|
+
|
|
155
|
+
```bash
|
|
156
|
+
npm run build
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Validation & Testing
|
|
160
|
+
|
|
161
|
+
### Final Validation Steps
|
|
162
|
+
|
|
163
|
+
1. Verify cookbook resolves through protocol:
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
ace-nav resolve cookbook://setup-starting-an-astro-project-with-ace
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
2. Verify assignment workflows load:
|
|
170
|
+
|
|
171
|
+
```bash
|
|
172
|
+
ace-bundle wfi://assign/create
|
|
173
|
+
ace-bundle wfi://assign/drive
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Success Criteria
|
|
177
|
+
|
|
178
|
+
- [x] Setup flow is action-first and reusable.
|
|
179
|
+
- [x] Provenance is explicit and traceable to real work artifacts.
|
|
180
|
+
- [x] Propagation guidance is concise and summary-only.
|
|
@@ -17,7 +17,7 @@ All ACE CLI gems use dry-cli. See [ADR-023](../../../docs/decisions/ADR-023-dry-
|
|
|
17
17
|
|
|
18
18
|
**Two patterns:**
|
|
19
19
|
|
|
20
|
-
- **Multi-command**: Subcommand tools (ace-bundle, ace-
|
|
20
|
+
- **Multi-command**: Subcommand tools (ace-bundle, ace-task)
|
|
21
21
|
- **Single-command**: One-action tools (ace-git-commit, ace-search)
|
|
22
22
|
|
|
23
23
|
## Multi-Command Pattern
|
|
@@ -162,7 +162,7 @@ end
|
|
|
162
162
|
|
|
163
163
|
## Nested Commands
|
|
164
164
|
|
|
165
|
-
For hierarchical commands (ace-
|
|
165
|
+
For hierarchical commands (ace-task, ace-git-worktree):
|
|
166
166
|
|
|
167
167
|
```ruby
|
|
168
168
|
# lib/ace/taskflow/cli.rb
|
|
@@ -17,7 +17,7 @@ All ACE CLI gems use ace-support-cli. See [ADR-023](../../../docs/decisions/ADR-
|
|
|
17
17
|
|
|
18
18
|
**Two patterns:**
|
|
19
19
|
|
|
20
|
-
- **Multi-command**: Subcommand tools (ace-bundle, ace-
|
|
20
|
+
- **Multi-command**: Subcommand tools (ace-bundle, ace-task)
|
|
21
21
|
- **Single-command**: One-action tools (ace-git-commit, ace-search)
|
|
22
22
|
|
|
23
23
|
## Multi-Command Pattern
|
|
@@ -162,7 +162,7 @@ end
|
|
|
162
162
|
|
|
163
163
|
## Nested Commands
|
|
164
164
|
|
|
165
|
-
For hierarchical commands (ace-
|
|
165
|
+
For hierarchical commands (ace-task, ace-git-worktree):
|
|
166
166
|
|
|
167
167
|
```ruby
|
|
168
168
|
# lib/ace/taskflow/cli.rb
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: as-handbook-manage-cookbooks
|
|
3
|
+
description: Create, update, and maintain cookbook assets and standards
|
|
4
|
+
# bundle: wfi://handbook/manage-cookbooks
|
|
5
|
+
# context: no-fork
|
|
6
|
+
# agent: general-purpose
|
|
7
|
+
user-invocable: true
|
|
8
|
+
allowed-tools:
|
|
9
|
+
- Bash(ace-handbook:*)
|
|
10
|
+
- Bash(ace-bundle:*)
|
|
11
|
+
- Read
|
|
12
|
+
- Write
|
|
13
|
+
- Edit
|
|
14
|
+
- MultiEdit
|
|
15
|
+
- Glob
|
|
16
|
+
- LS
|
|
17
|
+
- TodoWrite
|
|
18
|
+
argument-hint: "[cookbook-name] [action: create|update|review]"
|
|
19
|
+
last_modified: 2026-04-01
|
|
20
|
+
source: ace-handbook
|
|
21
|
+
integration:
|
|
22
|
+
targets:
|
|
23
|
+
- claude
|
|
24
|
+
- codex
|
|
25
|
+
- gemini
|
|
26
|
+
- opencode
|
|
27
|
+
- pi
|
|
28
|
+
providers: {}
|
|
29
|
+
skill:
|
|
30
|
+
kind: workflow
|
|
31
|
+
execution:
|
|
32
|
+
workflow: wfi://handbook/manage-cookbooks
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
Load and run `ace-bundle wfi://handbook/manage-cookbooks` in the current project, then follow the loaded workflow as the source of truth and execute it end-to-end instead of only summarizing it.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: as-handbook-review-cookbooks
|
|
3
|
+
description: Review and validate cookbook assets for quality and consistency
|
|
4
|
+
# bundle: wfi://handbook/review-cookbooks
|
|
5
|
+
# context: no-fork
|
|
6
|
+
# agent: general-purpose
|
|
7
|
+
user-invocable: true
|
|
8
|
+
allowed-tools:
|
|
9
|
+
- Bash(ace-handbook:*)
|
|
10
|
+
- Bash(ace-bundle:*)
|
|
11
|
+
- Read
|
|
12
|
+
- Glob
|
|
13
|
+
- LS
|
|
14
|
+
- TodoWrite
|
|
15
|
+
argument-hint: "[cookbook-name]"
|
|
16
|
+
last_modified: 2026-04-01
|
|
17
|
+
source: ace-handbook
|
|
18
|
+
integration:
|
|
19
|
+
targets:
|
|
20
|
+
- claude
|
|
21
|
+
- codex
|
|
22
|
+
- gemini
|
|
23
|
+
- opencode
|
|
24
|
+
- pi
|
|
25
|
+
providers: {}
|
|
26
|
+
skill:
|
|
27
|
+
kind: workflow
|
|
28
|
+
execution:
|
|
29
|
+
workflow: wfi://handbook/review-cookbooks
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
Load and run `ace-bundle wfi://handbook/review-cookbooks` in the current project, then follow the loaded workflow as the source of truth and execute it end-to-end instead of only summarizing it.
|
|
@@ -10,7 +10,7 @@ allowed-tools:
|
|
|
10
10
|
- Bash(ace-bundle:*)
|
|
11
11
|
- Read
|
|
12
12
|
argument-hint: "[gem-name...] [--dry-run]"
|
|
13
|
-
last_modified: 2026-
|
|
13
|
+
last_modified: 2026-04-10
|
|
14
14
|
source: ace-handbook
|
|
15
15
|
integration:
|
|
16
16
|
targets:
|
|
@@ -47,4 +47,4 @@ None
|
|
|
47
47
|
- Do the work described by the workflow instead of only summarizing it.
|
|
48
48
|
- When the workflow requires edits, tests, or commits, perform them in this project.
|
|
49
49
|
|
|
50
|
-
- After live publishing, recommend running `ace-test-e2e ace-monorepo-e2e
|
|
50
|
+
- After live publishing, recommend running `ace-test-e2e ace-monorepo-e2e TS-MONO-001` for installation verification.
|
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
---
|
|
2
2
|
doc-type: template
|
|
3
|
-
title: "
|
|
3
|
+
title: "{Category} Cookbook: {Descriptive Name}"
|
|
4
4
|
purpose: Documentation for ace-handbook/handbook/templates/cookbooks/cookbook.template.md
|
|
5
5
|
ace-docs:
|
|
6
6
|
last-updated: 2026-01-08
|
|
7
7
|
last-checked: 2026-03-21
|
|
8
8
|
---
|
|
9
9
|
|
|
10
|
-
#
|
|
10
|
+
# {Category} Cookbook: {Descriptive Name}
|
|
11
11
|
|
|
12
12
|
**Created**: YYYY-MM-DD
|
|
13
13
|
**Last Updated**: YYYY-MM-DD
|
|
14
|
-
**Category**:
|
|
15
|
-
**Audience**:
|
|
16
|
-
**Estimated Time**:
|
|
14
|
+
**Category**: {integration | setup | migration | debugging | automation | pattern}
|
|
15
|
+
**Audience**: {beginner | intermediate | advanced}
|
|
16
|
+
**Estimated Time**: {X hours/minutes}
|
|
17
17
|
|
|
18
18
|
## Purpose
|
|
19
19
|
|
|
@@ -40,9 +40,25 @@ Brief description of what this cookbook accomplishes and why it's valuable.
|
|
|
40
40
|
|
|
41
41
|
High-level summary of the approach and main steps involved.
|
|
42
42
|
|
|
43
|
+
## Source Provenance
|
|
44
|
+
|
|
45
|
+
Document the backward-derived sources used to build this cookbook.
|
|
46
|
+
|
|
47
|
+
- Source workflows/guides/docs:
|
|
48
|
+
- Validation evidence (commands, reports, or artifacts):
|
|
49
|
+
- Last source verification date:
|
|
50
|
+
|
|
51
|
+
## Propagation Notes
|
|
52
|
+
|
|
53
|
+
Capture concise downstream updates required after applying this cookbook.
|
|
54
|
+
|
|
55
|
+
- Documentation updates to apply:
|
|
56
|
+
- Agent guidance updates to apply:
|
|
57
|
+
- Summary-only propagation target notes (do not copy full cookbook body):
|
|
58
|
+
|
|
43
59
|
## Steps
|
|
44
60
|
|
|
45
|
-
### Step 1:
|
|
61
|
+
### Step 1: {Step Title}
|
|
46
62
|
|
|
47
63
|
**Objective**: What this step accomplishes
|
|
48
64
|
|
|
@@ -71,7 +87,7 @@ verification-command
|
|
|
71
87
|
- Common issue 1: Solution
|
|
72
88
|
- Common issue 2: Solution
|
|
73
89
|
|
|
74
|
-
### Step 2:
|
|
90
|
+
### Step 2: {Step Title}
|
|
75
91
|
|
|
76
92
|
**Objective**: What this step accomplishes
|
|
77
93
|
|
|
@@ -127,7 +143,7 @@ Expected results
|
|
|
127
143
|
|
|
128
144
|
## Examples
|
|
129
145
|
|
|
130
|
-
### Example 1:
|
|
146
|
+
### Example 1: {Scenario Name}
|
|
131
147
|
|
|
132
148
|
**Context**: Specific use case or scenario
|
|
133
149
|
|
|
@@ -139,7 +155,7 @@ Expected results
|
|
|
139
155
|
|
|
140
156
|
**Result**: What the outcome looks like
|
|
141
157
|
|
|
142
|
-
### Example 2:
|
|
158
|
+
### Example 2: {Another Scenario}
|
|
143
159
|
|
|
144
160
|
**Context**: Different use case
|
|
145
161
|
|
|
@@ -175,13 +191,13 @@ end
|
|
|
175
191
|
|
|
176
192
|
## Common Patterns
|
|
177
193
|
|
|
178
|
-
### Pattern 1:
|
|
194
|
+
### Pattern 1: {Pattern Name}
|
|
179
195
|
|
|
180
196
|
**When to use**: Specific conditions or scenarios
|
|
181
197
|
**How to implement**: Brief implementation guide
|
|
182
198
|
**Example**: Quick code or command example
|
|
183
199
|
|
|
184
|
-
### Pattern 2:
|
|
200
|
+
### Pattern 2: {Another Pattern}
|
|
185
201
|
|
|
186
202
|
**When to use**: Different scenario
|
|
187
203
|
**How to implement**: Implementation approach
|
|
@@ -189,14 +205,14 @@ end
|
|
|
189
205
|
|
|
190
206
|
## Troubleshooting
|
|
191
207
|
|
|
192
|
-
### Error:
|
|
208
|
+
### Error: {Common Error Message}
|
|
193
209
|
|
|
194
210
|
**Symptoms**: How this error manifests
|
|
195
211
|
**Cause**: Root cause of the issue
|
|
196
212
|
**Solution**: Step-by-step fix
|
|
197
213
|
**Prevention**: How to avoid in the future
|
|
198
214
|
|
|
199
|
-
### Issue:
|
|
215
|
+
### Issue: {Common Problem}
|
|
200
216
|
|
|
201
217
|
**Symptoms**: Observable behavior
|
|
202
218
|
**Diagnosis**: How to confirm this is the issue
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
doc-type: workflow
|
|
3
|
+
name: manage-cookbooks
|
|
4
|
+
title: Manage Cookbooks
|
|
5
|
+
description: Create and maintain handbook cookbook standards and assets
|
|
6
|
+
purpose: Documentation for ace-handbook/handbook/workflow-instructions/handbook/manage-cookbooks.wf.md
|
|
7
|
+
allowed-tools:
|
|
8
|
+
- Bash(ace-bundle:*)
|
|
9
|
+
- Bash(ace-handbook:*)
|
|
10
|
+
- Read
|
|
11
|
+
- Write
|
|
12
|
+
ace-docs:
|
|
13
|
+
last-updated: 2026-04-01
|
|
14
|
+
last-checked: 2026-04-01
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
# Manage Cookbooks
|
|
18
|
+
|
|
19
|
+
## Goal
|
|
20
|
+
|
|
21
|
+
Create, update, and maintain cookbook assets as a handbook-owned capability. This workflow defines the canonical
|
|
22
|
+
`.cookbook.md` model, provenance expectations, and downstream propagation requirements for project maintainers and agents.
|
|
23
|
+
|
|
24
|
+
## Prerequisites
|
|
25
|
+
|
|
26
|
+
- Understanding of handbook asset conventions
|
|
27
|
+
- Clear source material for backward-derived cookbook guidance
|
|
28
|
+
|
|
29
|
+
## Embedded Canonical Context
|
|
30
|
+
|
|
31
|
+
### Canonical cookbook format
|
|
32
|
+
|
|
33
|
+
Cookbooks must use `.cookbook.md` filenames and follow this required structure:
|
|
34
|
+
|
|
35
|
+
```markdown
|
|
36
|
+
# {Category} Cookbook: {Cookbook Name}
|
|
37
|
+
|
|
38
|
+
## Purpose
|
|
39
|
+
|
|
40
|
+
Brief description of what this cookbook accomplishes.
|
|
41
|
+
|
|
42
|
+
## Source Provenance
|
|
43
|
+
|
|
44
|
+
- Source workflows/guides/docs:
|
|
45
|
+
- Validation evidence:
|
|
46
|
+
|
|
47
|
+
## Steps
|
|
48
|
+
|
|
49
|
+
### Step 1: {Step Title}
|
|
50
|
+
|
|
51
|
+
# command
|
|
52
|
+
|
|
53
|
+
## Propagation Notes
|
|
54
|
+
|
|
55
|
+
- Documentation updates to apply:
|
|
56
|
+
- Agent guidance updates to apply:
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Canonical storage paths
|
|
60
|
+
|
|
61
|
+
- Package-owned cookbooks (inside `ace-handbook`): `ace-handbook/handbook/cookbooks/`
|
|
62
|
+
- Project-local cookbooks (outside package scope): `.ace-handbook/cookbooks/`
|
|
63
|
+
|
|
64
|
+
## Process Steps
|
|
65
|
+
|
|
66
|
+
1. **Define cookbook scope and audience:**
|
|
67
|
+
- Confirm cookbook category and intended audience.
|
|
68
|
+
- Ensure the cookbook solves a practical implementation problem.
|
|
69
|
+
2. **Collect source evidence before authoring:**
|
|
70
|
+
- Gather primary source inputs (existing workflows, implementation docs, validated command behavior).
|
|
71
|
+
- Record where each instruction originated.
|
|
72
|
+
3. **Author or update cookbook in canonical format:**
|
|
73
|
+
- Use `.cookbook.md` extension.
|
|
74
|
+
- Keep content action-oriented and operational.
|
|
75
|
+
- Store package-owned cookbooks under `ace-handbook/handbook/cookbooks/`.
|
|
76
|
+
- Store project-local cookbooks under `.ace-handbook/cookbooks/`.
|
|
77
|
+
4. **Encode provenance and validation source:**
|
|
78
|
+
- Add explicit provenance and validation references in the cookbook content.
|
|
79
|
+
- Ensure each major section can be traced back to source material.
|
|
80
|
+
5. **Add concise propagation guidance:**
|
|
81
|
+
- Include short downstream guidance for how cookbook outcomes should be reflected in docs and agent guidance.
|
|
82
|
+
- Do not duplicate full cookbook bodies into `CLAUDE.md` or `AGENTS.md`.
|
|
83
|
+
6. **Cross-check handbook ownership boundaries:**
|
|
84
|
+
- Confirm cookbook instructions refer to handbook workflows/skills, not `ace-docs` ownership.
|
|
85
|
+
- Keep cookbook standards in `ace-handbook` surfaces.
|
|
86
|
+
7. **Validate discovery readiness:**
|
|
87
|
+
- Confirm naming is protocol-friendly and resolves via `cookbook://`.
|
|
88
|
+
- Validate references and internal links.
|
|
89
|
+
- Verify the cookbook resides in the correct path:
|
|
90
|
+
- package-owned under `ace-handbook/handbook/cookbooks/`
|
|
91
|
+
- project-local under `.ace-handbook/cookbooks/`
|
|
92
|
+
8. **Finalize and synchronize integrations:**
|
|
93
|
+
- Run `ace-handbook sync` when canonical handbook skills changed.
|
|
94
|
+
- Update usage docs if command examples changed.
|
|
95
|
+
|
|
96
|
+
## Success Criteria
|
|
97
|
+
|
|
98
|
+
- Cookbook guidance is defined as a handbook-owned asset model.
|
|
99
|
+
- `.cookbook.md` remains the canonical format.
|
|
100
|
+
- Provenance, validation source, and propagation guidance are explicit.
|
|
101
|
+
- Content is discoverable through handbook cookbook protocol surfaces.
|
|
102
|
+
- Documentation and workflow references remain aligned.
|
|
103
|
+
|
|
104
|
+
## Validation Commands
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
ace-bundle wfi://handbook/manage-cookbooks
|
|
108
|
+
ace-bundle wfi://handbook/review-cookbooks
|
|
109
|
+
ace-nav list 'cookbook://*'
|
|
110
|
+
ace-handbook sync
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Error Handling
|
|
114
|
+
|
|
115
|
+
- **Missing provenance source:** stop authoring and collect source artifacts before finalizing.
|
|
116
|
+
- **Ownership drift (`ace-docs` references):** rewrite guidance to point to handbook-owned workflows/skills.
|
|
117
|
+
- **Discovery mismatch:** verify cookbook protocol registration and file naming/paths.
|
|
@@ -113,7 +113,7 @@ Execute complete delivery workflow for a task with automatic step tracking, ensu
|
|
|
113
113
|
* Follow versioning conventions
|
|
114
114
|
|
|
115
115
|
6. **Complete Task:**
|
|
116
|
-
* Mark task as done: `ace-
|
|
116
|
+
* Mark task as done: `ace-task done <ref>`
|
|
117
117
|
* Push to remote: `git push`
|
|
118
118
|
|
|
119
119
|
### Phase 2: PR & Initial Review
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
doc-type: workflow
|
|
3
|
+
name: review-cookbooks
|
|
4
|
+
title: Review Cookbooks
|
|
5
|
+
description: Review and validate cookbook assets and standards
|
|
6
|
+
purpose: Documentation for ace-handbook/handbook/workflow-instructions/handbook/review-cookbooks.wf.md
|
|
7
|
+
allowed-tools:
|
|
8
|
+
- Bash(ace-bundle:*)
|
|
9
|
+
- Bash(ace-handbook:*)
|
|
10
|
+
- Read
|
|
11
|
+
ace-docs:
|
|
12
|
+
last-updated: 2026-04-01
|
|
13
|
+
last-checked: 2026-04-01
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
# Review Cookbooks
|
|
17
|
+
|
|
18
|
+
## Goal
|
|
19
|
+
|
|
20
|
+
Review cookbook assets for standards compliance, provenance quality, discovery compatibility, and concise downstream
|
|
21
|
+
propagation guidance.
|
|
22
|
+
|
|
23
|
+
## Prerequisites
|
|
24
|
+
|
|
25
|
+
- Access to cookbook files under review
|
|
26
|
+
- Understanding of handbook workflow/skill ownership boundaries
|
|
27
|
+
|
|
28
|
+
## Embedded Review Standards
|
|
29
|
+
|
|
30
|
+
### Required canonical structure
|
|
31
|
+
|
|
32
|
+
Each cookbook under review must:
|
|
33
|
+
|
|
34
|
+
- use `.cookbook.md` file naming
|
|
35
|
+
- include `## Source Provenance` with explicit source references
|
|
36
|
+
- include `## Propagation Notes` with concise downstream updates
|
|
37
|
+
- keep workflow ownership guidance aligned to `ace-handbook`
|
|
38
|
+
|
|
39
|
+
### Canonical storage paths to validate
|
|
40
|
+
|
|
41
|
+
- Package-owned cookbooks (inside `ace-handbook`): `ace-handbook/handbook/cookbooks/`
|
|
42
|
+
- Project-local cookbooks (outside package scope): `.ace-handbook/cookbooks/`
|
|
43
|
+
|
|
44
|
+
## Process Steps
|
|
45
|
+
|
|
46
|
+
1. **Define review scope:**
|
|
47
|
+
- Review one cookbook, a category, or all cookbook files.
|
|
48
|
+
2. **Validate canonical format:**
|
|
49
|
+
- File naming uses `.cookbook.md`.
|
|
50
|
+
- Structure remains consistent with cookbook standards.
|
|
51
|
+
3. **Validate provenance and source traceability:**
|
|
52
|
+
- Cookbook includes backward-derived source material references.
|
|
53
|
+
- Validation source for key procedures is explicit.
|
|
54
|
+
4. **Validate propagation guidance quality:**
|
|
55
|
+
- Downstream propagation instructions are concise and actionable.
|
|
56
|
+
- No instructions suggest copying full cookbook text into `CLAUDE.md` or `AGENTS.md`.
|
|
57
|
+
5. **Validate ownership and workflow linkage:**
|
|
58
|
+
- Cookbook lifecycle references `ace-handbook` workflows/skills.
|
|
59
|
+
- No wording implies cookbook ownership lives in `ace-docs`.
|
|
60
|
+
6. **Validate discovery and command contracts:**
|
|
61
|
+
- Ensure cookbook names/locations are resolvable through `cookbook://`.
|
|
62
|
+
- Confirm package-owned vs project-local path placement is correct.
|
|
63
|
+
- Verify workflow commands referenced in cookbook guidance load correctly.
|
|
64
|
+
7. **Report findings with severity:**
|
|
65
|
+
- Critical: ownership/provenance/discovery breaks.
|
|
66
|
+
- Major: incomplete propagation or validation guidance.
|
|
67
|
+
- Minor: wording/formatting consistency issues.
|
|
68
|
+
|
|
69
|
+
## Review Checklist
|
|
70
|
+
|
|
71
|
+
- [ ] Uses `.cookbook.md` canonical format
|
|
72
|
+
- [ ] Includes provenance references
|
|
73
|
+
- [ ] Includes validation source references
|
|
74
|
+
- [ ] Includes concise propagation guidance
|
|
75
|
+
- [ ] Avoids ownership drift to `ace-docs`
|
|
76
|
+
- [ ] Respects `cookbook://` discovery requirements
|
|
77
|
+
|
|
78
|
+
## Validation Commands
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
ace-bundle wfi://handbook/manage-cookbooks
|
|
82
|
+
ace-bundle wfi://handbook/review-cookbooks
|
|
83
|
+
ace-nav list 'cookbook://*'
|
|
84
|
+
ace-nav resolve cookbook://setup-starting-an-astro-project-with-ace
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Success Criteria
|
|
88
|
+
|
|
89
|
+
- Cookbook reviews consistently enforce handbook cookbook standards.
|
|
90
|
+
- Findings clearly classify blocking vs non-blocking issues.
|
|
91
|
+
- Discovery and workflow command contracts are validated as part of review.
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
require "date"
|
|
4
4
|
require "yaml"
|
|
5
5
|
require "ace/support/nav"
|
|
6
|
+
require "pathname"
|
|
6
7
|
|
|
7
8
|
module Ace
|
|
8
9
|
module Handbook
|
|
@@ -17,21 +18,80 @@ module Ace
|
|
|
17
18
|
end
|
|
18
19
|
|
|
19
20
|
def all
|
|
20
|
-
|
|
21
|
-
parse_skill(resource.fetch(:path))
|
|
22
|
-
end
|
|
21
|
+
skill_paths.filter_map { |path| parse_skill(path) }
|
|
23
22
|
end
|
|
24
23
|
|
|
25
24
|
private
|
|
26
25
|
|
|
27
|
-
def
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
26
|
+
def skill_paths
|
|
27
|
+
index = {}
|
|
28
|
+
|
|
29
|
+
source_directories.each do |directory|
|
|
30
|
+
Dir.glob(File.join(directory, "**", "SKILL.md")).sort.each do |path|
|
|
31
|
+
frontmatter = parse_frontmatter(File.read(path))
|
|
32
|
+
name = frontmatter["name"]&.to_s
|
|
33
|
+
next if name.nil? || name.empty? || index.key?(name)
|
|
34
|
+
|
|
35
|
+
index[name] = path
|
|
36
|
+
rescue
|
|
37
|
+
next
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
|
|
41
|
+
index.values
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def source_directories
|
|
45
|
+
registry = Ace::Support::Nav::Molecules::SourceRegistry.new(start_path: project_root)
|
|
46
|
+
registry.sources_for_protocol("skill").filter_map do |source|
|
|
47
|
+
next if source.config.is_a?(Hash) && source.config["enabled"] == false
|
|
48
|
+
|
|
49
|
+
directory = resolve_source_directory(source)
|
|
50
|
+
next unless File.directory?(directory)
|
|
51
|
+
next if external_implicit_source?(source, directory)
|
|
52
|
+
|
|
53
|
+
directory
|
|
54
|
+
rescue
|
|
55
|
+
nil
|
|
56
|
+
end.uniq
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
def resolve_source_directory(source)
|
|
60
|
+
candidate = source.full_path
|
|
61
|
+
return candidate if File.directory?(candidate)
|
|
62
|
+
|
|
63
|
+
relative_path = source.config&.dig("relative_path")&.to_s&.strip
|
|
64
|
+
return nil if relative_path.nil? || relative_path.empty?
|
|
65
|
+
|
|
66
|
+
return nil unless source.config_file&.include?("/.ace-defaults/")
|
|
67
|
+
|
|
68
|
+
package_root = source.config_file.split("/.ace-defaults/").first
|
|
69
|
+
fallback = File.expand_path(relative_path, package_root)
|
|
70
|
+
File.directory?(fallback) ? fallback : nil
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
def external_implicit_source?(source, directory)
|
|
74
|
+
return false if path_within_project?(directory)
|
|
75
|
+
return false if explicit_registration?(source)
|
|
76
|
+
|
|
77
|
+
true
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def explicit_registration?(source)
|
|
81
|
+
%w[project user].include?(source.origin.to_s)
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
def path_within_project?(path)
|
|
85
|
+
candidate = Pathname.new(File.expand_path(path))
|
|
86
|
+
root = Pathname.new(File.expand_path(project_root))
|
|
87
|
+
candidate == root || candidate.to_s.start_with?("#{root}/")
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
def parse_frontmatter(content)
|
|
91
|
+
match = content.match(FRONTMATTER_PATTERN)
|
|
92
|
+
return {} unless match
|
|
33
93
|
|
|
34
|
-
|
|
94
|
+
YAML.safe_load(match[1], permitted_classes: [Date, Time], aliases: true) || {}
|
|
35
95
|
end
|
|
36
96
|
|
|
37
97
|
def parse_skill(path)
|
data/lib/ace/handbook/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ace-handbook
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.27.4
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Michal Czyz
|
|
8
8
|
bindir: exe
|
|
9
9
|
cert_chain: []
|
|
10
|
-
date: 2026-04-
|
|
10
|
+
date: 2026-04-20 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
12
12
|
- !ruby/object:Gem::Dependency
|
|
13
13
|
name: ace-support-config
|
|
@@ -117,6 +117,7 @@ extensions: []
|
|
|
117
117
|
extra_rdoc_files: []
|
|
118
118
|
files:
|
|
119
119
|
- ".ace-defaults/handbook/config.yml"
|
|
120
|
+
- ".ace-defaults/nav/protocols/cookbook-sources/ace-handbook.yml"
|
|
120
121
|
- ".ace-defaults/nav/protocols/guide-sources/ace-handbook.yml"
|
|
121
122
|
- ".ace-defaults/nav/protocols/skill-sources/ace-handbook.yml"
|
|
122
123
|
- ".ace-defaults/nav/protocols/tmpl-sources/ace-handbook.yml"
|
|
@@ -126,6 +127,8 @@ files:
|
|
|
126
127
|
- README.md
|
|
127
128
|
- Rakefile
|
|
128
129
|
- exe/ace-handbook
|
|
130
|
+
- handbook/cookbooks/setup-starting-a-multi-ruby-gem-monorepo-with-ace.cookbook.md
|
|
131
|
+
- handbook/cookbooks/setup-starting-an-astro-project-with-ace.cookbook.md
|
|
129
132
|
- handbook/guides/ai-agent-integration.g.md
|
|
130
133
|
- handbook/guides/atom-pattern.g.md
|
|
131
134
|
- handbook/guides/changelog.g.md
|
|
@@ -163,10 +166,12 @@ files:
|
|
|
163
166
|
- handbook/guides/workflow-context-embedding.g.md
|
|
164
167
|
- handbook/skills/as-handbook-init-project/SKILL.md
|
|
165
168
|
- handbook/skills/as-handbook-manage-agents/SKILL.md
|
|
169
|
+
- handbook/skills/as-handbook-manage-cookbooks/SKILL.md
|
|
166
170
|
- handbook/skills/as-handbook-manage-guides/SKILL.md
|
|
167
171
|
- handbook/skills/as-handbook-manage-workflows/SKILL.md
|
|
168
172
|
- handbook/skills/as-handbook-parallel-research/SKILL.md
|
|
169
173
|
- handbook/skills/as-handbook-perform-delivery/SKILL.md
|
|
174
|
+
- handbook/skills/as-handbook-review-cookbooks/SKILL.md
|
|
170
175
|
- handbook/skills/as-handbook-review-guides/SKILL.md
|
|
171
176
|
- handbook/skills/as-handbook-review-workflows/SKILL.md
|
|
172
177
|
- handbook/skills/as-handbook-synthesize-research/SKILL.md
|
|
@@ -180,11 +185,13 @@ files:
|
|
|
180
185
|
- handbook/templates/research-comparison.template.md
|
|
181
186
|
- handbook/workflow-instructions/handbook/init-project.wf.md
|
|
182
187
|
- handbook/workflow-instructions/handbook/manage-agents.wf.md
|
|
188
|
+
- handbook/workflow-instructions/handbook/manage-cookbooks.wf.md
|
|
183
189
|
- handbook/workflow-instructions/handbook/manage-guides.wf.md
|
|
184
190
|
- handbook/workflow-instructions/handbook/manage-workflows.wf.md
|
|
185
191
|
- handbook/workflow-instructions/handbook/parallel-research.wf.md
|
|
186
192
|
- handbook/workflow-instructions/handbook/perform-delivery.wf.md
|
|
187
193
|
- handbook/workflow-instructions/handbook/research.wf.md
|
|
194
|
+
- handbook/workflow-instructions/handbook/review-cookbooks.wf.md
|
|
188
195
|
- handbook/workflow-instructions/handbook/review-guides.wf.md
|
|
189
196
|
- handbook/workflow-instructions/handbook/review-workflows.wf.md
|
|
190
197
|
- handbook/workflow-instructions/handbook/synthesize-research.wf.md
|