Skip to content

Commit 73affd8

Browse files
authored
docs: reconcile narrative docs with v1.9.5 reality (#60)
- Update standards-doc count to 18 in .cursorrules, AGENTS.md, CLAUDE.md, and CONTRIBUTING.md (was 9 or 17 depending on file) - docs/index.html: standards grid expanded from 8 to 18 cards matching standards/README.md order; footer version updated from v1.5.0 to v1.9.5; standards count badge corrected to 18 - ROADMAP.md: Current Status updated to v1.9.5 with accurate prior-milestone list; Release Plan table updated with six Released range rows for v1.7.x through v1.9.x; speculative v1.7.0, v1.8.0, v1.9.0 narrative sections replaced with accurate content derived from git history and release notes; new sections added for v1.7.1-v1.7.5, v1.8.1-v1.8.5, and v1.9.1-v1.9.5 Patch range rows in the Release Plan table are deliberate: they group closely related patch series by theme rather than listing each patch individually. This is not a per-patch policy but a readability choice for series that shipped in rapid succession. standards/drift-checker.config.json intentionally left unstaged (Windows CRLF phantom, no content change). Signed-off-by: fOuttaMyPaint <154358121+TMHSDigital@users.noreply.github.com>
1 parent 765d320 commit 73affd8

6 files changed

Lines changed: 82 additions & 31 deletions

File tree

.cursorrules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ You are working on Developer Tools Directory, a meta-repository that catalogs, s
33
## Repo structure
44

55
- `registry.json` -- single source of truth for all 9 tool repos (name, type, counts, links, status)
6-
- `standards/` -- 9 Markdown docs defining conventions (folder structure, CI/CD, manifests, pages, commits, README, AGENTS.md, versioning)
6+
- `standards/` -- 18 Markdown docs defining conventions (folder structure, CI/CD, manifests, pages, commits, README, AGENTS.md, versioning, and more)
77
- `scaffold/create-tool.py` -- Python repo generator using Jinja2 templates
88
- `scaffold/templates/` -- Jinja2 templates producing a standards-compliant repo
99
- `site-template/` -- shared GitHub Pages build system for tool repos (build_site.py + template.html.j2 + fonts)

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This file tells AI coding agents how the Developer Tools Directory repo works an
99
This is a **meta-repository** -- it does not contain a Cursor plugin or MCP server itself. It catalogs, standardizes, and scaffolds other TMHSDigital developer tool repos. It contains:
1010

1111
- **`registry.json`** -- single source of truth for all tool repos. README, CLAUDE.md, and the catalog site's embedded registry are generated from it by `scripts/sync_from_registry.py`.
12-
- **`standards/`** -- 17 Markdown docs defining conventions for folder structure, CI/CD, plugin manifests, GitHub Pages, commits, README format, AGENTS.md format, versioning, testing, skills, rules, MCP servers, security, licensing, scope, lifecycle, and writing style.
12+
- **`standards/`** -- 18 Markdown docs defining conventions for folder structure, CI/CD, plugin manifests, GitHub Pages, commits, README format, AGENTS.md format, versioning, release-doc-sync, testing, skills, rules, MCP servers, security, licensing, scope, lifecycle, and writing style.
1313
- **`scaffold/`** -- Python repo generator (`create-tool.py`) with Jinja2 templates that produce a fully standards-compliant new tool repo.
1414
- **`scripts/`** -- automation utilities. `sync_from_registry.py` regenerates all derived artifacts from `registry.json`.
1515
- **`site-template/`** -- shared GitHub Pages build system for tool repos. `build_site.py` reads `.cursor-plugin/plugin.json`, `site.json`, `skills/`, `rules/`, and `mcp-tools.json` from a tool repo and renders `docs/index.html` via `template.html.j2`. Self-hosts Inter and JetBrains Mono fonts. Tool repos clone this directory in CI and run the build script at deploy time.

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Developer Tools Directory is a **meta-repository** that catalogs, standardizes,
1616
```
1717
Developer-Tools-Directory/
1818
registry.json # Source of truth for all tool repos
19-
standards/ # 17 convention docs (structure, CI/CD, testing, MCP, security, licensing, etc.)
19+
standards/ # 18 convention docs (structure, CI/CD, testing, MCP, security, licensing, etc.)
2020
scaffold/
2121
create-tool.py # Python repo generator (Jinja2)
2222
templates/ # Jinja2 templates for new repos

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Thank you for your interest in contributing. This guide covers everything you ne
2424
```
2525
Developer-Tools-Directory/
2626
registry.json # Tool catalog (source of truth)
27-
standards/ # Convention documentation (9 docs)
27+
standards/ # Convention documentation (18 docs)
2828
scaffold/
2929
create-tool.py # Repo generator script
3030
templates/ # Jinja2 templates for new repos

ROADMAP.md

Lines changed: 65 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,18 @@
44
55
## Current Status
66

7-
**v1.6.3** - Patch release. Resolves drafter-body detection and branch-protection residuals from the version-scheme migration. `release.yml` now treats a drafter body of `## What's Changed / * No changes` as empty and falls through to the commit-log fallback. `main` is now protected by a GitHub ruleset (`main protection`) with 7 required status checks including `feat/fix commits require VERSION bump`, squash-merge only, no force pushes, no deletion, empty bypass list. Documentation across AGENTS.md, CLAUDE.md, CONTRIBUTING.md, `.github/workflows/README.md`, and `standards/ci-cd.md` updated to reflect the PR-based workflow.
7+
**v1.9.5** - Patch release. Removes `paths-ignore` from the meta-repo `release.yml` so content-only changes still gate releases on commit prefix. Companion fix removes `paths-ignore` from the scaffold `release.yml.j2` template so generated repos get the same behavior.
88

99
Prior milestones in this line:
1010

11+
- **v1.9.4** - docs: update release-doc-sync header comment to reflect the @v1 / @v1.X floating-tag convention.
12+
- **v1.9.3** - fix: align scaffold output with current ecosystem patterns (ref #45).
13+
- **v1.9.2** - fix: release-doc-sync default meta-repo-ref changed to `v1` (floating major tag).
14+
- **v1.9.1** - fix: stale-counts policy correction; example sections and dialogue lines added to aggregate-scan skip list (DTD#37).
15+
- **v1.9.0** - CI maintenance. Node 24-compatible GitHub Actions versions, dependabot coverage extended to github-actions ecosystem, Sponsor button and FUNDING.yml, stale-counts DTD#12 skip for AGENTS.md and CLAUDE.md.
16+
- **v1.8.x** - release-doc-sync composite action (v1.8.0) plus fixes for checkout pollution, workspace cleanup, label-sync self-healing, floating-tag automation in `release.yml`, and version-bump-check parser.
17+
- **v1.7.x** - drift checker in two phases: Phase 1 (agents-template standard, scaffold updates, workflow docs); Phase 2 (core library, additional checks, CI integration, token separation, exit-code propagation).
18+
- **v1.6.3** - Drafter-body fix and branch-protection ruleset. `release.yml` treats a drafter body of `## What's Changed / * No changes` as empty. `main protection` ruleset established with 7 required checks.
1119
- **v1.6.2** - Release-drafter decoupling. Release-drafter no longer computes its own version; change-note aggregation only. Versioning is fully driven by the `VERSION` file and `release.yml`.
1220
- **v1.6.1** - `VERSION`-file-driven releases. Replaces conventional-commit auto-bump with an authoritative `VERSION` file; `feat:`/`fix:` commits require a VERSION bump enforced by CI.
1321
- **v1.6.0** - Standards and Governance. Nine new standards docs, registry-to-artifact sync automation, DCO + inbound license grant, scope and lifecycle principles, public-repo safety hardening.
@@ -26,9 +34,12 @@ Prior milestones in this line:
2634
| v1.6.1 | VERSION-file-driven releases | Released |
2735
| v1.6.2 | Release-drafter decoupling | Released |
2836
| v1.6.3 | Drafter-body fix and branch-protection ruleset | Released |
29-
| v1.7.0 | Sync Everywhere and Agent-File Drift | Planned |
30-
| v1.8.0 | Observability and Feedback | Planned |
31-
| v1.9.0 | Standards Versioning | Planned |
37+
| v1.7.0 | Drift Checker Foundation | Released |
38+
| v1.7.1 - v1.7.5 | Drift Checker Complete | Released |
39+
| v1.8.0 | Release Doc Sync | Released |
40+
| v1.8.1 - v1.8.5 | Release Doc Sync Fixes | Released |
41+
| v1.9.0 | CI Maintenance | Released |
42+
| v1.9.1 - v1.9.5 | Scaffold and Pipeline Fixes | Released |
3243

3344
---
3445

@@ -181,38 +192,68 @@ Close the content, automation, and governance gaps identified in the v1.5 audit.
181192

182193
---
183194

184-
## v1.7.0 - Sync Everywhere and Agent-File Drift
195+
## v1.7.0 - Drift Checker Foundation
185196

186-
Extend the single-source-of-truth pattern beyond the directory repo.
197+
Phase 1 of the drift checker project. Established the agents-template standard, updated scaffold templates, and aligned workflow documentation with the branch-protection ruleset.
187198

188-
- Generate `AGENTS.md` and `CLAUDE.md` sections in every tool repo from `registry.json` where they duplicate registry data
189-
- Add a `standards-version` frontmatter to every tool repo's `AGENTS.md` so the directory can audit compliance
190-
- Aggregate changelog workflow pulling each tool repo's `CHANGELOG.md` into a weekly digest on the catalog site
191-
- Cross-tool integration guidance: when to share code, when to duplicate, how to version shared modules
199+
- `standards/agents-template.md` added, documenting the required structure for AI agent guidance files in tool repos
200+
- Scaffold updated to generate compliant `AGENTS.md` from the new template
201+
- Workflow documentation across `AGENTS.md`, `CLAUDE.md`, and `.github/workflows/README.md` updated to reflect the active `main protection` ruleset
192202

193203
---
194204

195-
## v1.8.0 - Observability and Feedback
205+
## v1.7.1 - v1.7.5 - Drift Checker Complete
196206

197-
Empirical signals to drive standards revision.
207+
Phase 2: the drift checker itself. Automated detection of tool-repo policy drift surfaced as GitHub issues.
198208

199-
- Opt-in telemetry spec for MCP tool invocation counts
200-
- npm download aggregator on the catalog site (public data)
201-
- `docs/INSIGHTS.md` generated weekly showing top tools/skills by signal
202-
- CI check flagging skills not invoked in the last 90 days as dormant
203-
- Feedback loop: standards changes must cite an empirical observation or user report
209+
- `scripts/drift_check/` core library: checks for standards-version signals in `AGENTS.md`, `CLAUDE.md`, skills, and rules files against the meta-repo `VERSION`
210+
- Additional policy checks: broken standards links, required references, stale aggregate counts in markdown
211+
- CI integration: runs on push to `main` (when checker code or standards change), weekly on schedule, and on demand via `workflow_dispatch`
212+
- Token split: `DRIFT_CHECK_TOKEN` for cross-repo sparse-checkout reads, `GITHUB_TOKEN` for issue writes
213+
- Exit-code propagation fix for the composite action caller
204214

205215
---
206216

207-
## v1.9.0 - Standards Versioning
217+
## v1.8.0 - Release Doc Sync
208218

209-
Version the ecosystem itself.
219+
Composite action for keeping `CHANGELOG.md`, `CLAUDE.md`, and `ROADMAP.md` in sync after an automated release.
210220

211-
- Each standards doc gets a `standards-version` header
212-
- A per-standard changelog
213-
- Tool repos pin the standards version they claim to meet
214-
- Directory emits a compliance matrix per tool by standards version
215-
- Principles doc maintains its own version and changelog
221+
- `.github/actions/release-doc-sync/action.yml` composite action checks out the tool repo, runs the sync script, commits and pushes any drift
222+
- Designed for use in tool-repo `release.yml` workflows: `uses: TMHSDigital/Developer-Tools-Directory/.github/actions/release-doc-sync@v1`
223+
- `standards/release-doc-sync.md` documents the contract between the action and calling repos
224+
225+
---
226+
227+
## v1.8.1 - v1.8.5 - Release Doc Sync Fixes
228+
229+
Correctness fixes for the composite action and related CI machinery.
230+
231+
- Checkout pollution: action no longer contaminates the caller's working tree
232+
- Defensive workspace cleanup added on failure paths
233+
- Label-sync self-healing: ports the self-healing pattern to the meta-repo `label-sync.yml`
234+
- Floating-tag automation: `release.yml` now creates and updates `v1` and `v1.X` floating tags on every release
235+
- Version-bump-check parser: fixed silent pass-all bug affecting PRs with multi-line commit subjects
236+
237+
---
238+
239+
## v1.9.0 - CI Maintenance
240+
241+
Routine maintenance to keep the CI stack current and discoverable.
242+
243+
- GitHub Actions bumped to Node 24-compatible versions across all workflows
244+
- Dependabot coverage extended to the `github-actions` ecosystem
245+
- Sponsor button added via `.github/FUNDING.yml`
246+
- Stale-counts check: `AGENTS.md` and `CLAUDE.md` skipped wholesale by filename regardless of config (DTD#12); aggregate-truth for those files belongs in a per-repo validate-counts job
247+
248+
---
249+
250+
## v1.9.1 - v1.9.5 - Scaffold and Pipeline Fixes
251+
252+
- Stale-counts policy correction: example sections and roleplay dialogue lines excluded from aggregate scanning (DTD#37)
253+
- release-doc-sync `action.yml` default `meta-repo-ref` corrected to `v1` (floating major tag)
254+
- Scaffold `release.yml.j2` template: `paths-ignore` removed so content-only changes still gate releases on commit prefix
255+
- Scaffold output aligned with current ecosystem patterns (ref #45)
256+
- Meta-repo `release.yml`: `paths-ignore` removed for the same reason as the scaffold fix
216257

217258
---
218259

docs/index.html

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ <h1>Developer Tools Directory</h1>
257257
<section id="standards" class="section">
258258
<div class="section-header">
259259
<h2>Standards</h2>
260-
<span class="count">8</span>
260+
<span class="count">18</span>
261261
<div class="section-actions">
262262
<button class="btn-sm toggle-section" data-target="standards-body">Expand</button>
263263
</div>
@@ -271,9 +271,19 @@ <h2>Standards</h2>
271271
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/ci-cd.md" class="standard-card" target="_blank" rel="noopener"><h3>CI/CD</h3><p>GitHub Actions workflows every repo must have</p></a>
272272
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/github-pages.md" class="standard-card" target="_blank" rel="noopener"><h3>GitHub Pages</h3><p>Documentation site setup and deployment</p></a>
273273
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/commit-conventions.md" class="standard-card" target="_blank" rel="noopener"><h3>Commit Conventions</h3><p>Conventional commits and version bumping rules</p></a>
274-
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/versioning.md" class="standard-card" target="_blank" rel="noopener"><h3>Versioning</h3><p>Semver management and automated release flow</p></a>
275274
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/readme-template.md" class="standard-card" target="_blank" rel="noopener"><h3>README Template</h3><p>Standard README structure and required sections</p></a>
276275
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/agents-template.md" class="standard-card" target="_blank" rel="noopener"><h3>AGENTS.md Template</h3><p>AI agent guidance file structure</p></a>
276+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/versioning.md" class="standard-card" target="_blank" rel="noopener"><h3>Versioning</h3><p>Semver management and automated release flow</p></a>
277+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/release-doc-sync.md" class="standard-card" target="_blank" rel="noopener"><h3>Release Doc Sync</h3><p>Composite action contract for keeping CHANGELOG, CLAUDE, and ROADMAP in sync after a release</p></a>
278+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/testing.md" class="standard-card" target="_blank" rel="noopener"><h3>Testing</h3><p>Test frameworks, minimum coverage bar, and CI wiring</p></a>
279+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/skills.md" class="standard-card" target="_blank" rel="noopener"><h3>Skills</h3><p>SKILL.md structure and frontmatter conventions</p></a>
280+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/rules.md" class="standard-card" target="_blank" rel="noopener"><h3>Rules</h3><p>.mdc structure, globs, and the secrets rule pattern</p></a>
281+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/mcp-server.md" class="standard-card" target="_blank" rel="noopener"><h3>MCP Server</h3><p>Tool naming, runtime, transport, and destructive operation handling</p></a>
282+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/security.md" class="standard-card" target="_blank" rel="noopener"><h3>Security</h3><p>Vulnerability disclosure, secrets handling, and workflow supply chain</p></a>
283+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/licensing.md" class="standard-card" target="_blank" rel="noopener"><h3>Licensing</h3><p>DCO + inbound license grant model</p></a>
284+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/scope.md" class="standard-card" target="_blank" rel="noopener"><h3>Scope</h3><p>What belongs in the directory and what does not</p></a>
285+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/lifecycle.md" class="standard-card" target="_blank" rel="noopener"><h3>Lifecycle</h3><p>Tool status transitions from experimental to archived</p></a>
286+
<a href="https://github.com/TMHSDigital/Developer-Tools-Directory/blob/main/standards/writing-style.md" class="standard-card" target="_blank" rel="noopener"><h3>Writing Style</h3><p>Prose conventions across all repos</p></a>
277287
</div>
278288
</div>
279289
</details>
@@ -308,7 +318,7 @@ <h3>Scaffold Generator</h3>
308318
</div>
309319
<div class="footer-divider"></div>
310320
<div class="footer-meta">
311-
<span>v1.5.0</span>
321+
<span>v1.9.5</span>
312322
<span>&middot;</span>
313323
<span>CC-BY-NC-ND-4.0</span>
314324
<span>&middot;</span>

0 commit comments

Comments
 (0)