Skip to content

docs: add presets reference page and rename pack_id to preset_id#2243

Merged
mnriem merged 1 commit intogithub:mainfrom
mnriem:docs/add-presets-reference-page
Apr 16, 2026
Merged

docs: add presets reference page and rename pack_id to preset_id#2243
mnriem merged 1 commit intogithub:mainfrom
mnriem:docs/add-presets-reference-page

Conversation

@mnriem
Copy link
Copy Markdown
Collaborator

@mnriem mnriem commented Apr 16, 2026

Adds a dedicated docs/presets.md reference page and renames the CLI parameter from pack_id to preset_id for consistency.

Changes

  • New docs/presets.md — command reference for all 9 specify preset commands and 3 specify preset catalog commands, file resolution stack with Mermaid diagrams, catalog resolution order, and FAQ
  • src/specify_cli/__init__.py — renamed pack_id to preset_id across all preset CLI commands so --help shows PRESET_ID matching the docs
  • docs/toc.yml — added Presets under Reference section
  • README.md — updated presets link to published docs site (github.github.io/spec-kit/)

Motivation

Follows the same pattern established in #2241 (integrations) and #2242 (extensions). The presets reference page documents all CLI commands, the file resolution stack (with Mermaid diagrams showing the 4-tier priority system), catalog management, and FAQ.

Tests

All 179 preset tests pass after the pack_idpreset_id rename.

- New docs/presets.md: command reference for all 9 specify preset commands
  and 3 specify preset catalog commands, file resolution stack with Mermaid
  diagrams, catalog resolution order, and FAQ
- src/specify_cli/__init__.py: rename pack_id to preset_id across all preset
  CLI commands so --help shows PRESET_ID matching the docs
- docs/toc.yml: add Presets under Reference section
- README.md: update presets link to published docs site
Copilot AI review requested due to automatic review settings April 16, 2026 17:36
@mnriem mnriem merged commit 8d2797d into github:main Apr 16, 2026
15 checks passed
@mnriem mnriem deleted the docs/add-presets-reference-page branch April 16, 2026 17:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a dedicated presets reference page to the docs site and aligns the preset CLI argument naming with the published documentation by renaming the displayed parameter from pack_id to preset_id.

Changes:

  • Added docs/presets.md covering the full specify preset / specify preset catalog command surface, resolution order, and FAQ.
  • Renamed preset CLI argument display from pack_idpreset_id across preset commands so --help matches the docs.
  • Wired the new docs page into the docs TOC and updated README to link to the published presets reference page.
Show a summary per file
File Description
src/specify_cli/init.py Updates preset command argument naming (pack_idpreset_id) for consistent CLI help output.
docs/presets.md Introduces a new presets reference page, including command docs, catalog order, and resolution diagrams.
docs/toc.yml Adds Presets under the Reference section in the docs navigation.
README.md Updates the presets documentation link to point to the published docs site.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (3)

docs/presets.md:179

  • This table also uses || instead of standard Markdown table syntax, so it likely won’t render correctly on the docs site. Please convert it to the same | ... | format used elsewhere.
| Type      | Subdirectory   | Override path                              |
| --------- | -------------- | ------------------------------------------ |
| Templates | `templates/`   | `.specify/templates/overrides/`            |
| Commands  | `commands/`    | `.specify/templates/overrides/`            |
| Scripts   | `scripts/`     | `.specify/templates/overrides/scripts/`    |

docs/presets.md:106

  • This options table uses || instead of standard Markdown table formatting, so it likely won’t render correctly (same issue as earlier tables in this doc). Convert to single | pipes with a proper header separator row.
| Option                                       | Description                                        |
| -------------------------------------------- | -------------------------------------------------- |
| `--name <name>`                              | Required. Unique name for the catalog              |
| `--priority <N>`                             | Priority (default: 10; lower = higher precedence)  |
| `--install-allowed / --no-install-allowed`   | Whether presets can be installed from this catalog (default: discovery only) |
| `--description <text>`                       | Optional description                               |

docs/presets.md:28

  • Same table formatting issue here: rows start with || and are missing standard Markdown pipe formatting, so the options table likely won’t render correctly.
| Option           | Description                                              |
| ---------------- | -------------------------------------------------------- |
| `--dev <path>`   | Install from a local directory (for development)         |
| `--from <url>`   | Install from a custom URL instead of the catalog         |
| `--priority <N>` | Resolution priority (default: 10; lower = higher precedence) |
  • Files reviewed: 4/4 changed files
  • Comments generated: 3

Comment thread docs/presets.md

```mermaid
flowchart TB
A["File requested:<br/>plan-template.md"] --> B{"Project-local override?"}
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Mermaid example labels the input as plan-template.md, but specify preset resolve expects a template name without the .md extension (per CLI help: e.g., spec-template). Consider changing the diagram/text to plan-template (no extension) to avoid users passing *.md and getting a miss.

Suggested change
A["File requested:<br/>plan-template.md"] --> B{"Project-local override?"}
A["File requested:<br/>plan-template"] --> B{"Project-local override?"}

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines 527 to +529
For example, presets could restructure spec templates to require regulatory traceability, adapt the workflow to fit the methodology you use (e.g., Agile, Kanban, Waterfall, jobs-to-be-done, or domain-driven design), add mandatory security review gates to plans, enforce test-first task ordering, or localize the entire workflow to a different language. The [pirate-speak demo](https://github.com/mnriem/spec-kit-pirate-speak-preset-demo) shows just how deep the customization can go. Multiple presets can be stacked with priority ordering.

See the [Presets README](./presets/README.md) for the full guide, including resolution order, priority, and how to create your own.
See the [Presets reference](https://github.github.io/spec-kit/presets.html) for the full command guide, including resolution order and priority stacking.
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the code block immediately above, the install example uses specify preset add <preset-name>, but the CLI/docs are standardizing on preset_id (and --help will show PRESET_ID). Update the README example to <preset-id> / <preset_id> so users don’t assume the display name is accepted.

Copilot uses AI. Check for mistakes.
Comment thread docs/presets.md
Comment on lines +11 to +15
| Option | Description |
| ---------- | -------------------- |
| `--tag` | Filter by tag |
| `--author` | Filter by author |

Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown tables in this doc use || at the start of each row, which won’t render as tables in standard Markdown (and is inconsistent with other docs like docs/extensions.md). Use single | pipes and add the closing | per row.

This issue also appears in the following locations of the same file:

  • line 24
  • line 101
  • line 175

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants