ace-docs 0.32.0 → 0.34.1

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a6e19efbddfdca76c2740925ec5f832d9c7b4175c3e229653e1373b6aed8aad0
4
- data.tar.gz: 464c5c0600bad2f2db54043e60c04500ee73c295e744dac01cfbeb5d282ab546
3
+ metadata.gz: ce697d65c80ba44319cf2484f1a5568981b81e5c205a8397bbf33b0dbd69b22d
4
+ data.tar.gz: 8b2846bcff7af3e21e5411fa2e3e3babd06b9dc5718075e2c046adac082d29dc
5
5
  SHA512:
6
- metadata.gz: 9ec32d915500b4f8f83adb9ae39af524e641db6ff2fe4efd00ec2bdd6d468de5f261e9f93904764add88090fd9a2f5c54760d9fb8e14a8b4dde70c948431f65e
7
- data.tar.gz: 5e4be4df1834c16efc7ab1f30ef14aefcb28f33b5ccc84db185e0eb7467de4298b83efeb3f5eee76df023dc921c201acb6654c7a68c808fef7e9817d9c3a73f0
6
+ metadata.gz: 3354a595ec9ab354ac641ab07ae5568dde41e938feda0a5f734b41015a001a069e6c5cdb6de4ee89c3a714189b4afbec99e72582bc8eb14f148df5d73645f7bd
7
+ data.tar.gz: 9c56bd30cc6bd9392461d3cb28669aac49b2d37e4c9e22de61f5d051b93de6da0aa823a8b3d6422dbe5a153aff79d148bfa4e07c4fa06b910ed3092ee88e8469
data/CHANGELOG.md CHANGED
@@ -6,6 +6,39 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
8
  ## [Unreleased]
9
+ ## [0.34.1] - 2026-04-16
10
+
11
+ ### Fixed
12
+ - Made `analyze-consistency` fail closed when no report file is produced and aligned E2E verification with explicit provider-unavailable evidence.
13
+
14
+ ## [0.34.0] - 2026-04-14
15
+
16
+ ### Added
17
+ - Added a new goal-style `TS-DOCS-002-analysis-workflows` E2E scenario covering `ace-docs analyze` and `ace-docs analyze-consistency` command journeys with impact-first verification guidance.
18
+
19
+ ### Changed
20
+ - Hardened `TS-DOCS-001` verifier expectations for discover/validate/status to prioritize seeded state and stable outcome semantics over brittle phrasing checks.
21
+ - Expanded usage guidance for `analyze` and `analyze-consistency` with deterministic artifact/report location notes for reproducible CLI workflows.
22
+ - Updated `analyze` and `analyze-consistency` command help text to document output/report artifact locations and accurate exit-code behavior.
23
+
24
+ ## [0.33.1] - 2026-04-13
25
+
26
+ ### Changed
27
+ - Completed the batch i05 migration follow-through for this package and aligned it with the restarted `fast` / `feat` / `e2e` verification model.
28
+
29
+ ### Technical
30
+ - Included in the coordinated assignment-driven patch release for batch i05 package updates.
31
+
32
+
33
+ ## [0.33.0] - 2026-04-12
34
+
35
+ ### Changed
36
+ - Migrated `ace-docs` to the `fast` / `feat` / `e2e` testing model by moving deterministic coverage from legacy test paths into `test/fast` and `test/feat`, and aligning TS-DOCS-001 scenario metadata and runner/verifier assets with the new artifact contract.
37
+
38
+ ## [0.32.1] - 2026-04-10
39
+
40
+ ### Fixed
41
+ - Restored docs-management ignore coverage for legacy `test/e2e/**/*.md` scenario markdown paths during the E2E path migration.
9
42
 
10
43
  ## [0.32.0] - 2026-04-01
11
44
 
data/README.md CHANGED
@@ -36,5 +36,28 @@
36
36
 
37
37
  **Enforce docs quality in release loops** - pair with [ace-lint](../ace-lint) for markdown checks and use `ace-docs` update workflows to keep guides, READMEs, and references in sync.
38
38
 
39
+ For concrete analyze/update entry points and deterministic CLI examples, see the [Usage Guide](docs/usage.md#analyze) and the [analyze-and-update workflow examples](docs/usage.md#analyze-and-update-workflow).
40
+
41
+ ## Testing Contract
42
+
43
+ Run deterministic package coverage with:
44
+
45
+ ```bash
46
+ ace-test ace-docs
47
+ ace-test ace-docs all
48
+ ```
49
+
50
+ Run deterministic feature coverage:
51
+
52
+ ```bash
53
+ ace-test ace-docs feat
54
+ ```
55
+
56
+ Run retained workflow scenarios in E2E:
57
+
58
+ ```bash
59
+ ace-test-e2e ace-docs
60
+ ```
61
+
39
62
  ---
40
63
  [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)
@@ -11,13 +11,13 @@ ace-docs:
11
11
 
12
12
  ## Goal
13
13
 
14
- Synchronize the project roadmap (`.ace-taskflow/roadmap.md`) with the current state of releases and tasks in the `.ace-taskflow/` directory structure. This workflow analyzes release folders, updates the Planned Major Releases table, synchronizes cross-release dependencies, and maintains roadmap format compliance per the Roadmap Definition Guide.
14
+ Synchronize the project roadmap (`.ace-task/roadmap.md`) with the current state of releases and tasks in the `.ace-task/` directory structure. This workflow analyzes release folders, updates the Planned Major Releases table, synchronizes cross-release dependencies, and maintains roadmap format compliance per the Roadmap Definition Guide.
15
15
 
16
16
  ## Prerequisites
17
17
 
18
- * `.ace-taskflow/roadmap.md` exists and follows roadmap-definition.g.md structure
19
- * `.ace-taskflow/` directory contains release folders with release.md files
20
- * `ace-taskflow` CLI tool available for release queries
18
+ * `.ace-task/roadmap.md` exists and follows roadmap-definition.g.md structure
19
+ * `.ace-task/` directory contains release folders with release.md files
20
+ * `ace-task` CLI tool available for release queries
21
21
  * `ace-nav` available for workflow protocol support
22
22
  * Git repository in clean state for committing changes
23
23
 
@@ -33,7 +33,7 @@ Synchronize the project roadmap (`.ace-taskflow/roadmap.md`) with the current st
33
33
 
34
34
  ```bash
35
35
  # Get roadmap path
36
- cat .ace-taskflow/roadmap.md
36
+ cat .ace-task/roadmap.md
37
37
  ```
38
38
 
39
39
  **Capture current state:**
@@ -73,14 +73,14 @@ cat .ace-taskflow/roadmap.md
73
73
 
74
74
  ### 3. Analyze Release State
75
75
 
76
- **Discover all releases in .ace-taskflow structure:**
76
+ **Discover all releases in .ace-task structure:**
77
77
 
78
78
  ```bash
79
79
  # Get current release
80
80
  ace-release
81
81
 
82
82
  # List all release directories
83
- ls -d .ace-taskflow/v.*/ 2>/dev/null || echo "No releases found"
83
+ ls -d .ace-task/v.*/ 2>/dev/null || echo "No releases found"
84
84
  ```
85
85
 
86
86
  **For each release found, extract:**
@@ -101,17 +101,17 @@ ls -d .ace-taskflow/v.*/ 2>/dev/null || echo "No releases found"
101
101
  **Synchronization Rules:**
102
102
 
103
103
  1. **Add New Releases:**
104
- - If release exists in `.ace-taskflow/` but NOT in roadmap table
104
+ - If release exists in `.ace-task/` but NOT in roadmap table
105
105
  - Extract release information from release.md
106
106
  - Add row to Planned Major Releases table with proper format
107
107
 
108
108
  2. **Update Existing Releases:**
109
- - If release exists in both roadmap and `.ace-taskflow/`
109
+ - If release exists in both roadmap and `.ace-task/`
110
110
  - Compare current information with release.md
111
111
  - Update any changed fields (goals, target window, epics)
112
112
 
113
113
  3. **Remove Completed Releases:**
114
- - If release is marked done/completed in `.ace-taskflow/`
114
+ - If release is marked done/completed in `.ace-task/`
115
115
  - Remove entire row from Planned Major Releases table
116
116
  - Ensure release information captured in changelog
117
117
  - Document removal in Update History
@@ -140,7 +140,7 @@ ls -d .ace-taskflow/v.*/ 2>/dev/null || echo "No releases found"
140
140
  - Remove or update obsolete statements
141
141
 
142
142
  2. **Add new dependencies:**
143
- - Analyze task dependencies from `.ace-taskflow/` structure
143
+ - Analyze task dependencies from `.ace-task/` structure
144
144
  - Identify cross-release blocking dependencies
145
145
  - Add clear dependency statements to Section 5
146
146
 
@@ -199,7 +199,7 @@ Add new row to Update History table (Section 6) at the TOP:
199
199
  - Version numbers use semantic versioning
200
200
 
201
201
  3. **Consistency Check:**
202
- - Releases in table match `.ace-taskflow/` structure
202
+ - Releases in table match `.ace-task/` structure
203
203
  - Dependencies reference valid releases/epics
204
204
  - Update history reflects changes made
205
205
 
@@ -214,10 +214,10 @@ Add new row to Update History table (Section 6) at the TOP:
214
214
 
215
215
  ```bash
216
216
  # Review changes before committing
217
- git diff .ace-taskflow/roadmap.md
217
+ git diff .ace-task/roadmap.md
218
218
 
219
219
  # Stage roadmap file
220
- git add .ace-taskflow/roadmap.md
220
+ git add .ace-task/roadmap.md
221
221
 
222
222
  # Commit with descriptive message
223
223
  git commit -m "docs(roadmap): update planned releases and synchronize with current state"
@@ -229,7 +229,7 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
229
229
  - Examples:
230
230
  - `docs(roadmap): add v.0.9.0 Mono-Repo to planned releases`
231
231
  - `docs(roadmap): remove completed v.0.8.0 from planned releases`
232
- - `docs(roadmap): synchronize release status with .ace-taskflow structure`
232
+ - `docs(roadmap): synchronize release status with .ace-task structure`
233
233
 
234
234
  ## Error Handling
235
235
 
@@ -254,8 +254,8 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
254
254
  - Inconsistent release naming
255
255
 
256
256
  **Recovery Steps:**
257
- 1. Report discrepancies between `.ace-taskflow/` and roadmap
258
- 2. Determine authoritative source (usually `.ace-taskflow/` structure)
257
+ 1. Report discrepancies between `.ace-task/` and roadmap
258
+ 2. Determine authoritative source (usually `.ace-task/` structure)
259
259
  3. Update roadmap to match actual release state
260
260
  4. Document assumptions in Update History
261
261
 
@@ -328,7 +328,7 @@ git commit -m "docs(roadmap): update planned releases and synchronize with curre
328
328
  ## Success Criteria
329
329
 
330
330
  - [ ] Roadmap format validated against roadmap-definition.g.md
331
- - [ ] Planned Major Releases table synchronized with `.ace-taskflow/` structure
331
+ - [ ] Planned Major Releases table synchronized with `.ace-task/` structure
332
332
  - [ ] Completed releases removed from roadmap table
333
333
  - [ ] Cross-release dependencies updated and accurate
334
334
  - [ ] Front matter `last_reviewed` date updated to today
@@ -411,10 +411,10 @@ status: [draft|active|archived]
411
411
  ## References
412
412
 
413
413
  - **Roadmap Definition Guide**: `dev-handbook/guides/roadmap-definition.g.md`
414
- - **Current Roadmap**: `.ace-taskflow/roadmap.md`
414
+ - **Current Roadmap**: `.ace-task/roadmap.md`
415
415
  - **Draft Release Workflow**: `wfi://release/draft`
416
416
  - **Publish Release Workflow**: `wfi://release/publish`
417
- - **ace-taskflow CLI**: For release queries and task analysis
417
+ - **ace-task CLI**: For release queries and task analysis
418
418
 
419
419
  ---
420
420
 
@@ -42,7 +42,7 @@ Systematically update usage documentation files based on user feedback, task req
42
42
  find . -name "usage.md" -path "*/ux/*" -o -name "usage.md" -path "*/docs/*"
43
43
 
44
44
  # Or check specific task folder
45
- ls -la .ace-taskflow/v.*/t/*/ux/usage.md
45
+ ls -la .ace-task/v.*/t/*/ux/usage.md
46
46
  ```
47
47
  * Extract key requirements:
48
48
  - What needs to be documented
@@ -102,7 +102,7 @@ Systematically update usage documentation files based on user feedback, task req
102
102
  **Commands/Steps**:
103
103
  ```bash
104
104
  # Command with comments
105
- ace-taskflow command --flag value
105
+ ace-task command --flag value
106
106
  ```
107
107
 
108
108
  **Expected Output**:
@@ -159,7 +159,7 @@ Systematically update usage documentation files based on user feedback, task req
159
159
  ### Bash CLI Commands
160
160
  Commands without `/` are terminal/bash commands:
161
161
  ```bash
162
- ace-taskflow command
162
+ ace-task command
163
163
  ```
164
164
 
165
165
  ### Claude Code Commands (Slash Commands)
@@ -469,7 +469,7 @@ feature:
469
469
  **Available Commands:**
470
470
  - `/ace:[command1]` - [Description]
471
471
  - `/ace:[command2]` - [Description]
472
- - `ace-taskflow [command]` - [CLI equivalent if exists]
472
+ - `ace-task [command]` - [CLI equivalent if exists]
473
473
 
474
474
  ## Command Types
475
475
 
@@ -482,7 +482,7 @@ Commands starting with `/` are executed **within Claude Code**:
482
482
  ### Bash CLI Commands
483
483
  Commands without `/` are **terminal/bash commands**:
484
484
  ```bash
485
- ace-taskflow [command]
485
+ ace-task [command]
486
486
  ```
487
487
 
488
488
  ## Usage Scenarios
@@ -493,7 +493,7 @@ ace-taskflow [command]
493
493
 
494
494
  ```bash
495
495
  # Step 1: Preparation (bash command)
496
- ace-taskflow list
496
+ ace-task list
497
497
 
498
498
  # Step 2: Execution (Claude command)
499
499
  /ace:[command]
@@ -538,13 +538,13 @@ Summary: 2 items completed
538
538
  [Sample output]
539
539
  ```
540
540
 
541
- ### `ace-taskflow [command]`
541
+ ### `ace-task [command]`
542
542
 
543
543
  **Purpose**: [CLI tool purpose]
544
544
 
545
545
  **Usage**:
546
546
  ```bash
547
- ace-taskflow [command] [options]
547
+ ace-task [command] [options]
548
548
  ```
549
549
 
550
550
  **Options**:
@@ -590,7 +590,7 @@ Friday: [Review]
590
590
  **Solution**:
591
591
  ```bash
592
592
  # Verify installation
593
- which ace-taskflow
593
+ which ace-task
594
594
 
595
595
  # Check workflow exists
596
596
  ace-bundle wfi://[workflow] --verify
@@ -44,8 +44,9 @@ module Ace
44
44
  Project config: .ace/docs/config.yml
45
45
 
46
46
  Output:
47
- Analysis results printed to stdout
48
- Exit codes: 0 (success), 1 (error)
47
+ Prints an analysis summary and writes session artifacts to .ace-local/docs/analyze-<id>/
48
+ Key files: analysis.md, metadata.yml, prompt-system.md, prompt-user.md
49
+ Exit codes: 0 (success), 1 (error), 2 (no changes), 3 (analysis error)
49
50
  DESC
50
51
 
51
52
  example [
@@ -34,8 +34,9 @@ module Ace
34
34
  Project config: .ace/docs/config.yml
35
35
 
36
36
  Output:
37
- Consistency report in markdown format (default)
38
- Exit codes: 0 (success), 1 (issues found with --strict), 2 (error)
37
+ Prints report location and writes artifacts under .ace-local/docs/sessions/analyze-consistency-<timestamp>/
38
+ Key files: report.md, metadata.yml, documents.json
39
+ Exit codes: 0 (success), 1 (error)
39
40
  DESC
40
41
 
41
42
  example [
@@ -76,7 +76,9 @@ module Ace
76
76
  puts "This may take a few minutes for large document sets..." if documents.count > 10
77
77
  response = execute_llm_query(prompts, session_dir)
78
78
 
79
- # Response is already saved to report.md by ace-llm's output option
79
+ unless response && File.exist?(response) && !File.read(response).strip.empty?
80
+ raise "Consistency analysis did not produce a completed report"
81
+ end
80
82
 
81
83
  # Save metadata for reference
82
84
  save_metadata(documents, pattern, session_dir)
@@ -230,7 +230,7 @@ module Ace
230
230
  %r{^#{Regexp.escape(tmp_dir)}/}, # Only ignore <project_root>/tmp/
231
231
  %r{/coverage/},
232
232
  %r{/_legacy/},
233
- %r{/\.ace-taskflow/done/}
233
+ %r{/\.ace-task/done/}
234
234
  ]
235
235
 
236
236
  # Add patterns from config if available
@@ -2,6 +2,6 @@
2
2
 
3
3
  module Ace
4
4
  module Docs
5
- VERSION = '0.32.0'
5
+ VERSION = '0.34.1'
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ace-docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.32.0
4
+ version: 0.34.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Michal Czyz
8
8
  bindir: exe
9
9
  cert_chain: []
10
- date: 2026-04-05 00:00:00.000000000 Z
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