docs: update publishing guide with Category and Effect columns#1912
docs: update publishing guide with Category and Effect columns#1912imviancagrace wants to merge 1 commit intogithub:mainfrom
Conversation
The README table now has Category and Effect columns (added in github#1897), but the publishing guide template still showed the old 3-column format. Update to match so extension authors know to include both fields. Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
Updates the extension publishing documentation to reflect the newer “Category” and “Effect” columns intended for the community extensions comparison table.
Changes:
- Updates the example “Available Extensions” table row to include Category and Effect columns.
- Adds guidance describing allowed values for Category and Effect.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Add your extension to the Available Extensions table in `extensions/README.md`: | ||
|
|
||
| ```markdown | ||
| | Your Extension Name | Brief description of what it does | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | ||
| | Your Extension Name | Brief description of what it does | `category` | Effect | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | ||
| ``` |
There was a problem hiding this comment.
The publishing guide now instructs adding a 5-column row (including Category/Effect), but extensions/README.md currently has a 3-column table (| Extension | Purpose | URL |). As written, this example row won’t match the actual table format; either update extensions/README.md in the same change-set or keep the guide consistent with the existing 3-column README table.
|
|
||
| ```markdown | ||
| | Your Extension Name | Brief description of what it does | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | ||
| | Your Extension Name | Brief description of what it does | `category` | Effect | [repo-name](https://github.com/your-org/spec-kit-your-extension) | |
There was a problem hiding this comment.
In the example table row, category is shown in backticks while the Effect column is the literal word "Effect" (not a placeholder/value). Consider using real placeholder values (e.g., one of the listed categories and either Read-only/Read+Write) and keep formatting consistent with the README table (which uses plain text rather than inline code formatting).
| | Your Extension Name | Brief description of what it does | `category` | Effect | [repo-name](https://github.com/your-org/spec-kit-your-extension) | | |
| | Your Extension Name | Brief description of what it does | docs | Read-only | [repo-name](https://github.com/your-org/spec-kit-your-extension) | |
| **Category** — pick the one that best fits your extension: | ||
|
|
||
| - `docs` — reads, validates, or generates spec artifacts | ||
| - `code` — reviews, validates, or modifies source code | ||
| - `process` — orchestrates workflow across phases | ||
| - `integration` — syncs with external platforms | ||
| - `visibility` — reports on project health or progress |
There was a problem hiding this comment.
This new Category section can be confused with the later "### Valid Tags" section, which already uses the label "Category" to describe a tag taxonomy (e.g., issue-tracking, vcs, etc.). To avoid ambiguity, consider renaming this table field to something more specific (e.g., "Extension Category") or adding a short note clarifying it’s the README table column, not the tag category list.
Description
Follow-up to #1897. The README table now has Category and Effect columns, but the publishing guide template still showed the old 3-column format. This updates the example row and adds descriptions of each Category and Effect value so extension authors know what to include.
Testing
N/A — documentation-only change.
AI Disclosure
Used Cursor (Claude) to apply the same column update from #1897 to the publishing guide. All content reviewed by the author.
Made with Cursor