Skip to content

Commit ed1e302

Browse files
committed
chore(docs): finalize markdownlint cleanups and branding
- apply remaining markdown formatting fixes in docs and agent prompts - remove trailing-space and list-spacing markdownlint issues in repo docs - update CLI tagline branding text
1 parent 8ad626a commit ed1e302

6 files changed

Lines changed: 16 additions & 2 deletions

File tree

.github/agents/speckit.harvest.agent.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Harvest valuable knowledge from completed specs, stale documentation, and in-pro
2929
Additionally, scan source code for comments that reference completed specs, plans, or tasks and rewrite them as self-contained code documentation.
3030

3131
The output is:
32+
3233
1. Updated living documents (CHANGELOG, Guide.md) with harvested knowledge
3334
2. Cleaned code comments (spec references → self-contained descriptions)
3435
3. Stale files moved to `.archive/` with preserved folder structure
@@ -125,6 +126,7 @@ For each file in `.documentation/` (recursive, never `.archive/`):
125126
| **Living Reference** | Top-level `.documentation/*.md`, Guide.md, CHANGELOG.md | Keep — may update |
126127

127128
**Never archive:**
129+
128130
- `/.documentation/memory/constitution.md`
129131
- `/.documentation/scripts/` and `/.documentation/templates/`
130132
- `/.documentation/Guide.md` — update it instead
@@ -206,6 +208,7 @@ If the user says **modify**, apply their changes to the plan and re-present befo
206208
#### 4a. Update CHANGELOG.md
207209

208210
For each completed spec NOT already in CHANGELOG:
211+
209212
1. Read the spec's `spec.md`, `plan.md`, and `tasks.md`
210213
2. Extract: spec number, key changes, what was delivered
211214
3. Prepend a new entry above existing content:
@@ -225,6 +228,7 @@ Never modify existing CHANGELOG entries.
225228
#### 4b. Update .documentation/Guide.md
226229

227230
If completed specs introduced:
231+
228232
- New patterns or conventions → update the relevant section
229233
- New directories or files in `.documentation/` → update the directory map
230234
- Deprecated old patterns → note the deprecation
@@ -234,6 +238,7 @@ The guide describes the **current state only** — no historical content.
234238
#### 4c. Update .github/copilot-instructions.md (if it exists)
235239

236240
If completed specs introduced:
241+
237242
- New import paths, module names, or architectural patterns
238243
- New document schemas or field names
239244
- Deprecations of old patterns
@@ -249,6 +254,7 @@ For each spec/task reference identified in the pre-scan:
249254
3. Apply the edit
250255

251256
**Rules**:
257+
252258
- Never remove a comment without understanding its purpose first
253259
- If the comment accurately describes behavior but just has a spec prefix, strip only the prefix
254260
- If the comment is a pure task marker with no behavioral value, remove it entirely
@@ -268,6 +274,7 @@ For each spec/task reference identified in the pre-scan:
268274
6. After moving, verify no active file references the archived paths
269275

270276
**Do not move:**
277+
271278
- `/.documentation/memory/constitution.md`
272279
- `/.documentation/scripts/`
273280
- `/.documentation/templates/`

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ To test your templates, commands, and other changes locally, follow these steps:
106106
```
107107

108108
Interactive mode provides:
109+
109110
- Detailed commit analysis (author, date, files changed, diff stats)
110111
- Implications explained for each category (AUTO/ADAPT/IGNORE/EVALUATE)
111112
- Conflict detection with Spark-specific files

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1169,6 +1169,7 @@ See **[FORK_DIVERGENCE.md](./FORK_DIVERGENCE.md)** for:
11691169
```
11701170

11711171
This mode:
1172+
11721173
- Shows full commit details and file changes
11731174
- Explains implications for Spark architecture
11741175
- Detects potential conflicts with Spark-specific files

extensions/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@ Community-contributed extensions for [Spec Kit Spark](https://github.com/MarkHaz
1010

1111
## Adding Your Extension
1212

13-
Extensions provide a way to add specialized workflows and commands to Spec Kit Spark without modifying the core.
13+
Extensions provide a way to add specialized workflows and commands to Spec Kit Spark without modifying the core.
1414

1515
**For Extension Developers:**
16+
1617
- Extensions can provide custom commands, hooks, and templates
1718
- Package your extension as a GitHub repository with proper structure
1819
- Submit to the community catalog via pull request
1920

2021
**For Extension Users:**
22+
2123
- Browse available extensions in `catalog.community.json`
2224
- Install extensions to add domain-specific workflows (regulatory compliance, specialized testing, etc.)
2325
- Extensions work alongside Spark's built-in commands (`/speckit.critic`, `/speckit.quickfix`, etc.)

release_notes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,20 @@ You can use these releases with your agent of choice. We recommend using the Spe
2828
## Recent Changes
2929

3030
### Version 1.1.0 (February 8, 2026)
31+
3132
- New `specify upgrade` command for simplified project upgrades
3233
- Migration scripts for Windows (PowerShell) and Linux/Mac (Bash)
3334
- Comprehensive migration documentation and guides
3435
- Auto-detection of AI assistants and migration needs
3536
- Dry-run mode and safety checks for upgrade process
3637

3738
### Version 1.0.3 (February 6, 2026)
39+
3840
- Fixed critical double documentation path bug
3941
- Enhanced path transformation regex patterns
4042

4143
### Version 1.0.0 (February 3, 2026)
44+
4245
- First major release with standard semantic versioning
4346
- Transition to `.documentation/` directory structure
4447
- Constitution-powered commands

src/specify_cli/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ def _format_rate_limit_error(status_code: int, headers: httpx.Headers, url: str)
241241
╚══════╝╚═╝ ╚══════╝ ╚═════╝╚═╝╚═╝ ╚═╝
242242
"""
243243

244-
TAGLINE = "GitHub Spec Kit - Spec-Driven Development Toolkit"
244+
TAGLINE = "Spec Kit Spark (markhazleton) - Spec-Driven Development Toolkit"
245245
class StepTracker:
246246
"""Track and render hierarchical steps without emojis, similar to Claude Code tree output.
247247
Supports live auto-refresh via an attached refresh callback.

0 commit comments

Comments
 (0)