Skip to content

Commit ad62357

Browse files
authored
docs: consolidate Community sections in README (#2736)
* docs: consolidate Community sections in README Replace four separate Community sections (Extensions, Presets, Walkthroughs, Friends) with a single consolidated section containing a bullet list, one shared disclaimer, and both publishing guide links. * fix: broken community anchor links and missing Hermes hook note injection - Update README.md and extensions/README.md to point community extension links to the docs site instead of removed section anchor - Add post_process_skill_content() call in Hermes setup() so hook command notes are injected into generated skills - Add Hermes test override for test_hook_sections_explain_dotted_command_conversion with Path.home() monkeypatch
1 parent 57a518a commit ad62357

4 files changed

Lines changed: 31 additions & 26 deletions

File tree

README.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@
2222
- [🤔 What is Spec-Driven Development?](#-what-is-spec-driven-development)
2323
- [⚡ Get Started](#-get-started)
2424
- [📽️ Video Overview](#️-video-overview)
25-
- [🧩 Community Extensions](#-community-extensions)
26-
- [🎨 Community Presets](#-community-presets)
27-
- [🚶 Community Walkthroughs](#-community-walkthroughs)
28-
- [🛠️ Community Friends](#️-community-friends)
25+
- [🌍 Community](#-community)
2926
- [🤖 Supported AI Coding Agent Integrations](#-supported-ai-coding-agent-integrations)
3027
- [🔧 Specify CLI Reference](#-specify-cli-reference)
3128
- [🧩 Making Spec Kit Your Own: Extensions & Presets](#-making-spec-kit-your-own-extensions--presets)
@@ -112,31 +109,19 @@ Want to see Spec Kit in action? Watch our [video overview](https://www.youtube.c
112109

113110
[![Spec Kit video header](/media/spec-kit-video-header.jpg)](https://www.youtube.com/watch?v=a9eR1xsfvHg&pp=0gcJCckJAYcqIYzv)
114111

115-
## 🧩 Community Extensions
112+
## 🌍 Community
116113

117-
Community-contributed extensions add new commands, hooks, and capabilities to Spec Kit. See the full list on the [Community Extensions](https://github.github.io/spec-kit/community/extensions.html) page.
114+
Explore community-contributed resources on the [Spec Kit docs site](https://github.github.io/spec-kit/):
118115

119-
> [!NOTE]
120-
> Community extensions are independently created and maintained by their respective authors. Maintainers only verify that catalog entries are complete and correctly formatted — they do **not review, audit, endorse, or support the extension code itself**. Review extension source code before installation and use at your own discretion.
121-
122-
To submit your own extension, see the [Extension Publishing Guide](extensions/EXTENSION-PUBLISHING-GUIDE.md).
123-
124-
## 🎨 Community Presets
125-
126-
Community-contributed presets customize how Spec Kit behaves — overriding templates, commands, and terminology without changing any tooling. See the full list on the [Community Presets](https://github.github.io/spec-kit/community/presets.html) page.
116+
- [Extensions](https://github.github.io/spec-kit/community/extensions.html) — commands, hooks, and capabilities
117+
- [Presets](https://github.github.io/spec-kit/community/presets.html) — template and terminology overrides
118+
- [Walkthroughs](https://github.github.io/spec-kit/community/walkthroughs.html) — end-to-end SDD scenarios
119+
- [Friends](https://github.github.io/spec-kit/community/friends.html) — projects that extend or build on Spec Kit
127120

128121
> [!NOTE]
129-
> Community presets are third-party contributions and are not maintained by the Spec Kit team. Review them carefully before use, and see the docs page above for the full disclaimer.
130-
131-
To submit your own preset, see the [Presets Publishing Guide](presets/PUBLISHING.md).
132-
133-
## 🚶 Community Walkthroughs
134-
135-
See Spec-Driven Development in action across different scenarios with community-contributed walkthroughs; find the full list on the [Community Walkthroughs](https://github.github.io/spec-kit/community/walkthroughs.html) page.
136-
137-
## 🛠️ Community Friends
122+
> Community contributions are independently created and maintained by their respective authors. Review source code before installation and use at your own discretion.
138123
139-
Community projects that extend, visualize, or build on Spec Kit. See the full list on the [Community Friends](https://github.github.io/spec-kit/community/friends.html) page.
124+
Want to contribute? See the [Extension Publishing Guide](extensions/EXTENSION-PUBLISHING-GUIDE.md) or the [Presets Publishing Guide](presets/PUBLISHING.md).
140125

141126
## 🤖 Supported AI Coding Agent Integrations
142127

@@ -206,7 +191,7 @@ specify extension add <extension-name>
206191

207192
For example, extensions could add Jira integration, post-implementation code review, V-Model test traceability, or project health diagnostics.
208193

209-
See the [Extensions reference](https://github.github.io/spec-kit/reference/extensions.html) for the full command guide. Browse the [community extensions](#-community-extensions) above for what's available.
194+
See the [Extensions reference](https://github.github.io/spec-kit/reference/extensions.html) for the full command guide. Browse the [community extensions](https://github.github.io/spec-kit/community/extensions.html) for what's available.
210195

211196
### Presets — Customize Existing Workflows
212197

extensions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ specify extension add <extension-name> --from https://github.com/org/spec-kit-ex
7676
7777
🔍 **Browse and search community extensions on the [Community Extensions website](https://speckit-community.github.io/extensions/).**
7878

79-
See the [Community Extensions](../README.md#-community-extensions) section in the main README for the full list of available community-contributed extensions.
79+
See the [Community Extensions](https://github.github.io/spec-kit/community/extensions.html) page for the full list of available community-contributed extensions.
8080

8181
For the raw catalog data, see [`catalog.community.json`](catalog.community.json).
8282

src/specify_cli/integrations/hermes/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ def _quote(v: str) -> str:
172172
f"{processed_body}"
173173
)
174174

175+
skill_content = self.post_process_skill_content(skill_content)
176+
175177
# Write directly to global ~/.hermes/skills/speckit-<name>/SKILL.md
176178
skill_dir = global_skills_dir / skill_name
177179
skill_dir.mkdir(parents=True, exist_ok=True)

tests/integrations/test_integration_hermes.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,24 @@ def test_pre_existing_skills_not_removed(self, tmp_path, monkeypatch):
197197
"Foreign skill was removed by teardown"
198198
)
199199

200+
def test_hook_sections_explain_dotted_command_conversion(self, tmp_path, monkeypatch):
201+
"""Override: Hermes skills live in global ~/.hermes/skills/."""
202+
home = _fake_home(tmp_path)
203+
monkeypatch.setattr(Path, "home", lambda: home)
204+
205+
i = get_integration(self.KEY)
206+
m = IntegrationManifest(self.KEY, tmp_path)
207+
i.setup(tmp_path, m)
208+
specify_skill = home / ".hermes" / "skills" / "speckit-specify" / "SKILL.md"
209+
assert specify_skill.exists()
210+
content = specify_skill.read_text(encoding="utf-8")
211+
assert "replace dots" in content, (
212+
"speckit-specify should explain dotted hook command conversion"
213+
)
214+
assert content.count("replace dots") == content.count(
215+
"- For each executable hook, output the following"
216+
)
217+
200218
def test_complete_file_inventory_sh(self, tmp_path, monkeypatch):
201219
"""Override: Hermes init produces no local SKILL.md files,
202220
only the empty .hermes/skills/ marker."""

0 commit comments

Comments
 (0)