sdd-forge 0.1.0-alpha.26 → 0.1.0-alpha.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -26
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,23 +1,23 @@
1
- # {{data: project.name("")}}sdd-forge{{/data}}
1
+ # <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} -->
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/sdd-forge.svg)](https://www.npmjs.com/package/sdd-forge)
4
4
 
5
- > **Alpha:** This tool is currently in alpha. APIs, command structure, and configuration formats may change without notice. Not recommended for production use.
5
+ > **Alpha:** This tool is currently in alpha. The API, command structure, and configuration format may change without notice. Please avoid using it in production environments.
6
6
 
7
- **A CLI tool that automatically generates and maintains project documentation via source code analysis + AI.**
7
+ **A CLI tool that automatically generates and maintains project documentation using source code analysis + AI.**
8
8
 
9
- Statically analyzes your codebase and combines templates with AI to auto-generate `docs/`.
9
+ It statically analyzes your codebase and combines templates with AI to auto-generate `docs/`.
10
10
  The Spec-Driven Development (SDD) workflow also automates documentation updates when adding features or making changes.
11
11
 
12
12
  ## Features
13
13
 
14
- - **Zero dependencies** — Runs on Node.js 18+ only. No npm packages required
15
- - **Automatic source analysis** — Statically analyzes controllers, models, routes, and config files to extract structural data
14
+ - **Zero dependencies** — Runs on Node.js 18+ only. No npm dependencies
15
+ - **Automatic source code analysis** — Statically analyzes controllers, models, routes, and config files to extract structural data
16
16
  - **AI document generation** — AI automatically expands `{{text}}` directives in templates
17
- - **Template inheritance** — Four-layer inheritance (base → arch → preset → project-local) for full customization
18
- - **SDD workflow** — Manage the spec → gate → implement → forge → review development cycle with commands
19
- - **Multi-language support** — Auto-generate documentation in multiple languages via translate / generate modes
20
- - **AI agent integration** — Supports Claude Code (skills) and Codex CLI
17
+ - **Template inheritance** — Customizable via 4-layer inheritance: base → arch → preset → project-local
18
+ - **SDD workflow** — Manage the spec → gate → implement → forge → review cycle with commands
19
+ - **Multilingual support** — Auto-generate documentation in multiple languages via translate / generate modes
20
+ - **AI agent integration** — Compatible with Claude Code (skills) and Codex CLI
21
21
  - **Multi-preset** — Supports Node.js CLI / CakePHP2 / Laravel / Symfony
22
22
 
23
23
  ## Quick Start
@@ -26,23 +26,23 @@ The Spec-Driven Development (SDD) workflow also automates documentation updates
26
26
 
27
27
  <pre>
28
28
  # npm
29
- npm install -g {{data: project.name("")}}sdd-forge{{/data}}
29
+ npm install -g <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} -->
30
30
 
31
31
  # yarn
32
- yarn global add {{data: project.name("")}}sdd-forge{{/data}}
32
+ yarn global add <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} -->
33
33
 
34
34
  # pnpm
35
- pnpm add -g {{data: project.name("")}}sdd-forge{{/data}}
35
+ pnpm add -g <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} -->
36
36
  </pre>
37
37
 
38
38
  ### Setup & Document Generation
39
39
 
40
40
  <pre>
41
41
  # 1. Register your project (interactive wizard)
42
- {{data: project.name("")}}sdd-forge{{/data}} setup
42
+ <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} --> setup
43
43
 
44
- # 2. Generate all documentation (scan → init → data → text → readme → agents → translate)
45
- {{data: project.name("")}}sdd-forge{{/data}} build
44
+ # 2. Generate all documentation at once (scan → init → data → text → readme → agents → translate)
45
+ <!-- {{data: project.name("")}} -->sdd-forge<!-- {{/data}} --> build
46
46
  </pre>
47
47
 
48
48
  This generates `docs/` and `README.md` in one step.
@@ -62,7 +62,7 @@ This generates `docs/` and `README.md` in one step.
62
62
  | `readme` | Auto-generate `README.md` from `docs/` |
63
63
  | `forge` | Iteratively improve documentation with AI |
64
64
  | `review` | Check documentation quality |
65
- | `translate` | Multi-language translation (default language → others) |
65
+ | `translate` | Multilingual translation (default language → others) |
66
66
  | `upgrade` | Update preset templates to the latest version |
67
67
 
68
68
  ### SDD Workflow
@@ -81,16 +81,16 @@ This generates `docs/` and `README.md` in one step.
81
81
  |---|---|
82
82
  | `default` | Set the default project |
83
83
  | `presets` | List available presets |
84
- | `help` | Display command list |
84
+ | `help` | Show command list |
85
85
 
86
86
  ## SDD Workflow
87
87
 
88
- The feature addition / change flow:
88
+ The flow for adding features or making changes:
89
89
 
90
90
  ```
91
- spec Create spec (feature branch + spec.md)
91
+ spec Create a spec (feature branch + spec.md)
92
92
 
93
- gate Spec gate check (PASS when no open questions)
93
+ gate Spec gate check (PASS if no unresolved items)
94
94
 
95
95
  implement Write code after gate PASS
96
96
 
@@ -106,17 +106,17 @@ The feature addition / change flow:
106
106
  Run the SDD workflow with skills:
107
107
 
108
108
  ```
109
- /sdd-flow-start — Start spec creation → gate → implementation
110
- /sdd-flow-close — Finish with forge → review → commit → merge
109
+ /sdd-flow-start — Start: create spec → gate → implement
110
+ /sdd-flow-close — Finish: forge → review → commit → merge
111
111
  ```
112
112
 
113
113
  #### Codex CLI
114
114
 
115
- Run the workflow from prompts:
115
+ Run the workflow from a prompt:
116
116
 
117
117
  ```
118
- $sdd-flow-start — Start spec creation → gate → implementation
119
- $sdd-flow-close — Finish with forge → review → commit → merge
118
+ $sdd-flow-start — Start: create spec → gate → implement
119
+ $sdd-flow-close — Finish: forge → review → commit → merge
120
120
  ```
121
121
 
122
122
  ## Configuration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "sdd-forge",
3
- "version": "0.1.0-alpha.26",
3
+ "version": "0.1.0-alpha.27",
4
4
  "description": "Spec-Driven Development tooling for automated documentation generation",
5
5
  "repository": {
6
6
  "type": "git",