docs: Document dual-catalog system for extensions#1689
Conversation
- Clarify distinction between catalog.json (curated) and catalog.community.json (reference) - Update EXTENSION-DEVELOPMENT-GUIDE.md to explain community catalog submission - Update EXTENSION-PUBLISHING-GUIDE.md with dual-catalog workflow - Update EXTENSION-USER-GUIDE.md with catalog selection guidance - Expand README.md with comprehensive catalog explanation - Update RFC-EXTENSION-SYSTEM.md with dual-catalog design and current implementation - Change GitHub references from statsperform to github - Add SPECKIT_CATALOG_URL environment variable documentation This clarifies how organizations can curate their own catalog while browsing community-contributed extensions for discovery.
There was a problem hiding this comment.
Pull request overview
This PR updates Spec Kit’s extension documentation to clearly explain the dual-catalog model: an empty-by-default curated catalog.json used by the CLI, and a community reference catalog.community.json intended for discovery.
Changes:
- Documented the curated vs community catalog split and the discover → review → curate workflow across extension docs.
- Updated publishing/development guidance to submit to
catalog.community.jsonand keepextensions/README.mdin sync. - Expanded RFC and user docs with current catalog override behavior via
SPECKIT_CATALOG_URLand marked proposed catalog-management commands as future.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| extensions/RFC-EXTENSION-SYSTEM.md | Documents the dual-catalog design and clarifies current vs future catalog configuration mechanisms. |
| extensions/README.md | Introduces an “Extension Catalogs” overview and new guidance for making extensions available/installed. |
| extensions/EXTENSION-USER-GUIDE.md | Adds guidance and pointers to the catalog model and customization flow. |
| extensions/EXTENSION-PUBLISHING-GUIDE.md | Updates publisher workflow to target catalog.community.json and adds README/table update requirements. |
| extensions/EXTENSION-DEVELOPMENT-GUIDE.md | Updates development guidance to reflect community catalog submission and curation flow. |
Comments suppressed due to low confidence (1)
extensions/EXTENSION-USER-GUIDE.md:87
- "Shows all extensions in your organization's catalog" is misleading with the current defaults (the default catalog URL is the upstream GitHub
catalog.json, which is empty by design). Please align this sentence with the actual default behavior and/or mentionSPECKIT_CATALOG_URLas the mechanism to use an organization-managed catalog.
Shows all extensions in your organization's catalog.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 2. **Create a GitHub release** for your extension | ||
| 3. **Submit a Pull Request** that: | ||
| - Adds your extension to `extensions/catalog.community.json` | ||
| - Updates this README with your extension in the Available Extensions table |
There was a problem hiding this comment.
The text refers to "Available Extensions table" but the actual section title on line 69 is "Available Community Extensions". For clarity and consistency, consider updating this to "Available Community Extensions table".
| - Updates this README with your extension in the Available Extensions table | |
| - Updates this README with your extension in the Available Community Extensions table |
|
|
||
| Spec Kit uses two catalog files with different purposes: | ||
|
|
||
| #### User Catalog (`catalog.json`) |
There was a problem hiding this comment.
The section title "User Catalog" in RFC-EXTENSION-SYSTEM.md (line 865) is inconsistent with "Your Catalog" used in README.md (line 9) for the same catalog.json file. Consider using consistent terminology across both documents. Recommend "Your Catalog" as it's clearer for organizational use.
| #### User Catalog (`catalog.json`) | |
| #### Your Catalog (`catalog.json`) |
| - [x] All commands working | ||
| - [x] No security vulnerabilities | ||
| - [x] Added to extensions/catalog.community.json | ||
| - [x] Added to extensions/README.md Available Extensions table |
There was a problem hiding this comment.
The checklist item refers to "Available Extensions table" but the actual section title in README.md is "Available Community Extensions" (line 69). For clarity and consistency, consider updating this to "Available Community Extensions table".
| - [x] Added to extensions/README.md Available Extensions table | |
| - [x] Added to extensions/README.md Available Community Extensions table |
* docs: Document dual-catalog system for extensions - Clarify distinction between catalog.json (curated) and catalog.community.json (reference) - Update EXTENSION-DEVELOPMENT-GUIDE.md to explain community catalog submission - Update EXTENSION-PUBLISHING-GUIDE.md with dual-catalog workflow - Update EXTENSION-USER-GUIDE.md with catalog selection guidance - Expand README.md with comprehensive catalog explanation - Update RFC-EXTENSION-SYSTEM.md with dual-catalog design and current implementation - Change GitHub references from statsperform to github - Add SPECKIT_CATALOG_URL environment variable documentation This clarifies how organizations can curate their own catalog while browsing community-contributed extensions for discovery. * Update extensions/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update extensions/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update extensions/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Description
This PR documents the dual-catalog system for Spec Kit extensions, clarifying the distinction between
catalog.json(curated) andcatalog.community.json(reference).Closes #1687
Changes
Documentation Updates
EXTENSION-DEVELOPMENT-GUIDE.md
catalog.community.jsonEXTENSION-PUBLISHING-GUIDE.md
catalog.jsontocatalog.community.jsonEXTENSION-USER-GUIDE.md
catalog.jsonbeing emptyREADME.md
RFC-EXTENSION-SYSTEM.md
Impact
Testing
Type of Change