docs(presets): add lean preset README and enrich catalog metadata#2340
docs(presets): add lean preset README and enrich catalog metadata#2340mnriem wants to merge 1 commit intogithub:mainfrom
Conversation
- Add README.md documenting the lean workflow preset, its commands, when to use it, and development instructions. - Add license, requires.speckit_version, and provides.commands fields to the lean preset catalog entry. - Add "core" tag to preset.yml for discoverability.
There was a problem hiding this comment.
Pull request overview
Adds documentation and richer catalog metadata for the bundled lean preset to improve discoverability and clarify usage within the Spec Kit preset ecosystem.
Changes:
- Adds a new
presets/lean/README.mddescribing the Lean workflow and usage/development commands. - Enriches
presets/catalog.jsonwith license, Spec Kit version requirement, and “provides” metadata for the lean entry. - Adds a
"core"tag to the lean preset manifest for better discoverability.
Show a summary per file
| File | Description |
|---|---|
| presets/lean/preset.yml | Adds "core" to the preset’s tag list. |
| presets/lean/README.md | Introduces Lean preset documentation (usage, commands, dev workflow, license). |
| presets/catalog.json | Adds license/requirements/provides metadata to the official lean catalog entry. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (2)
presets/lean/README.md:17
- The “Output” column suggests files are written to the repo root (e.g.,
spec.md), but the lean command templates write artifacts under the selected<feature_directory>/(seepresets/lean/commands/speckit.*.md). Update the outputs here to reflect the actual paths so users aren’t confused.
| `speckit.specify` | `spec.md` | Create a specification from a feature description |
| `speckit.plan` | `plan.md` | Create an implementation plan from the spec |
| `speckit.tasks` | `tasks.md` | Create dependency-ordered tasks from spec and plan |
| `speckit.implement` | *(code)* | Execute all tasks in order, marking progress |
| `speckit.constitution` | `constitution.md` | Create or update the project constitution |
presets/lean/README.md:21
- This says “no separate template files involved”, but the preset provides command templates from
presets/lean/commands/speckit.*.md. Consider rephrasing to clarify that Lean replaces the core workflow commands with leaner command templates (rather than implying there are no template files).
Lean overrides the five core workflow commands with self-contained prompts that produce each artifact directly — no separate template files involved. The result is a shorter, more direct workflow.
- Files reviewed: 3/3 changed files
- Comments generated: 3
| "license": "MIT", | ||
| "bundled": true, | ||
| "requires": { | ||
| "speckit_version": ">=0.6.0" | ||
| }, |
There was a problem hiding this comment.
presets/catalog.json includes a top-level updated_at timestamp, but it wasn’t updated along with these metadata changes. Bump updated_at to reflect the catalog modification time so downstream consumers/humans don’t treat the catalog metadata as stale.
| "speckit_version": ">=0.6.0" | ||
| }, | ||
| "provides": { | ||
| "commands": 5 |
There was a problem hiding this comment.
provides in preset catalog entries elsewhere in this repo consistently includes a templates count (even when 0) (e.g., presets/catalog.community.json around lines 21-24; presets/PUBLISHING.md example around lines 193-196). For consistency (and to avoid consumers assuming the key exists), add provides.templates here too (Lean provides 5 templates, all command-type).
| "commands": 5 | |
| "commands": 5, | |
| "templates": 5 |
| | Command | Output | Description | | ||
| |---------|--------|-------------| | ||
| | `speckit.specify` | `spec.md` | Create a specification from a feature description | |
There was a problem hiding this comment.
The Markdown table syntax is incorrect (|| prefix). GitHub won’t render this as a table; use single leading/trailing | cells (and match the separator row) so it renders properly.
This issue also appears in the following locations of the same file:
- line 13
- line 21
Adds documentation and metadata improvements for the bundled lean preset:
presets/lean/README.md— New README documenting the lean workflow preset, its commands, when to use it, and development instructions.presets/catalog.json— Addslicense,requires.speckit_version, andprovides.commandsfields to the lean preset entry.presets/lean/preset.yml— Adds"core"tag for discoverability.