From b4a9d66b5c04559a7bcba4e4a0cedbc392647db8 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Mon, 29 Jun 2026 12:40:49 +0100 Subject: [PATCH] docs: post-canon reference + factual fixes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Now that you've authorised header edits, finishing the deferred doc work: - Path refs updated to the new canon (descriptiles/, descriptiles/anchors/, bot_directives/) in ai/README.adoc, AI-CONVENTIONS.adoc, bot_directives/README.adoc — incl. fixing pre-existing root-vs-6a2 path bugs. - bot_directives/README.adoc: title 'Agent Instructions' -> 'Bot Directives'; relationship section reconciled (this dir is the former agent_instructions). - TEST-NEEDS.md: CI workflow count 21 -> 14 (actual). - ROADMAP.adoc: marked v1.0.0 shipped (2026-05-29 per CHANGELOG); status updated. - Added/normalised CC-BY-SA-4.0 + canonical owner-string headers on all edited docs (dropped the (hyperpolymath)/year variant so they pass the file-type hook). Co-Authored-By: Claude Opus 4.8 (1M context) --- .machine_readable/ai/README.adoc | 8 +++++--- .machine_readable/bot_directives/README.adoc | 8 ++++---- ROADMAP.adoc | 19 ++++++++++--------- TEST-NEEDS.md | 6 +++++- docs/practice/AI-CONVENTIONS.adoc | 18 +++++++++--------- 5 files changed, 33 insertions(+), 26 deletions(-) diff --git a/.machine_readable/ai/README.adoc b/.machine_readable/ai/README.adoc index 121bbc8..a5dec59 100644 --- a/.machine_readable/ai/README.adoc +++ b/.machine_readable/ai/README.adoc @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: CC-BY-SA-4.0 +// Copyright (c) Jonathan D.A. Jewell = AI Guidance Directory Put AI-facing instructions in this folder. @@ -14,9 +16,9 @@ Avoid scattering agent instruction files around the repo root. Recommended machine read order: -* `.machine_readable/anchors/ANCHOR.a2ml` +* `.machine_readable/descriptiles/anchors/ANCHOR.a2ml` * `.machine_readable/policies/MAINTENANCE-AXES.a2ml` * `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml` * `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml` -* `.machine_readable/STATE.a2ml` -* `.machine_readable/META.a2ml` +* `.machine_readable/descriptiles/STATE.a2ml` +* `.machine_readable/descriptiles/META.a2ml` diff --git a/.machine_readable/bot_directives/README.adoc b/.machine_readable/bot_directives/README.adoc index 1cc7487..dff8237 100644 --- a/.machine_readable/bot_directives/README.adoc +++ b/.machine_readable/bot_directives/README.adoc @@ -1,6 +1,6 @@ // SPDX-License-Identifier: CC-BY-SA-4.0 -// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) -= Agent Instructions +// Copyright (c) Jonathan D.A. Jewell += Bot Directives :toc: preamble Methodology-aware configuration for AI agents. Read by any AI agent @@ -32,8 +32,8 @@ Methodology-aware configuration for AI agents. Read by any AI agent == Relationship to Other Files * `AGENTIC.a2ml` says WHAT agents can do (permissions, gating) -* `agent_instructions/` says HOW agents should work (methodology) -* `bot_directives/` says what the gitbot-fleet does (fleet-specific) +* `bot_directives/` (this directory) says HOW agents should work — methodology + and fleet-wide directives (formerly `agent_instructions/`) * `CLAUDE.md` says how Claude specifically should work (Claude-specific) == Reference diff --git a/ROADMAP.adoc b/ROADMAP.adoc index 8536fb0..c1d9551 100644 --- a/ROADMAP.adoc +++ b/ROADMAP.adoc @@ -1,21 +1,22 @@ // SPDX-License-Identifier: CC-BY-SA-4.0 +// Copyright (c) Jonathan D.A. Jewell = A2ml Validate Action Roadmap == Current Status -Initial development phase. +v1.0.0 released 2026-05-29 — stable. See `CHANGELOG.md`. == Milestones -=== v0.1.0 - Foundation -* [ ] Core functionality -* [ ] Basic documentation -* [ ] CI/CD pipeline +=== v0.1.0 - Foundation (released) +* [x] Core functionality +* [x] Basic documentation +* [x] CI/CD pipeline -=== v1.0.0 - Stable Release -* [ ] Full feature set -* [ ] Comprehensive tests -* [ ] Production ready +=== v1.0.0 - Stable Release (released 2026-05-29) +* [x] Full feature set +* [x] Comprehensive tests +* [x] Production ready == Future Directions diff --git a/TEST-NEEDS.md b/TEST-NEEDS.md index c4da123..3099e2a 100644 --- a/TEST-NEEDS.md +++ b/TEST-NEEDS.md @@ -1,3 +1,7 @@ + # TEST-NEEDS.md — a2ml-validate-action ## CRG Grade: C — ACHIEVED 2026-04-04 @@ -7,7 +11,7 @@ | Category | Count | Notes | |----------|-------|-------| | Test directories | 2 | Location(s): /verification/tests, /tests | -| CI workflows | 21 | Running tests on GitHub Actions | +| CI workflows | 14 | Running tests on GitHub Actions | | Tests | Present | Configured in CI workflows | ## What's Covered diff --git a/docs/practice/AI-CONVENTIONS.adoc b/docs/practice/AI-CONVENTIONS.adoc index 58e132b..fcdd523 100644 --- a/docs/practice/AI-CONVENTIONS.adoc +++ b/docs/practice/AI-CONVENTIONS.adoc @@ -1,6 +1,6 @@ +// SPDX-License-Identifier: CC-BY-SA-4.0 +// Copyright (c) Jonathan D.A. Jewell = AI Conventions - - # AI Conventions (Authoritative Source) @@ -10,12 +10,12 @@ Per-tool config files (.cursorrules, .clinerules, etc.) reference this document. ## Session Startup 1. Read `0-AI-MANIFEST.a2ml` FIRST (mandatory gatekeeper). -2. Read `.machine_readable/STATE.a2ml` for current status and blockers. -3. Read `.machine_readable/anchors/ANCHOR.a2ml` for canonical authority boundaries. +2. Read `.machine_readable/descriptiles/STATE.a2ml` for current status and blockers. +3. Read `.machine_readable/descriptiles/anchors/ANCHOR.a2ml` for canonical authority boundaries. 4. Read `.machine_readable/policies/MAINTENANCE-AXES.a2ml` for maintenance/audit sequencing. 5. Read `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml` for baseline controls. 6. Read `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml` for execution order. -7. Read `.machine_readable/AGENTIC.a2ml` for agent constraints. +7. Read `.machine_readable/descriptiles/AGENTIC.a2ml` for agent constraints. ## License @@ -29,7 +29,7 @@ Per-tool config files (.cursorrules, .clinerules, etc.) reference this document. - Name: **Jonathan D.A. Jewell** - Email: **j.d.a.jewell@open.ac.uk** -- Copyright: `Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) ` +- Copyright: `Copyright (c) Jonathan D.A. Jewell ` ## State Files @@ -77,9 +77,9 @@ Use `just` (justfile) for all build, test, lint, and format tasks. ## References - `0-AI-MANIFEST.a2ml` -- universal AI entry point -- `.machine_readable/AGENTIC.a2ml` -- agent permissions and constraints -- `.machine_readable/STATE.a2ml` -- current project state -- `.machine_readable/anchors/ANCHOR.a2ml` -- canonical authority and policy boundary +- `.machine_readable/descriptiles/AGENTIC.a2ml` -- agent permissions and constraints +- `.machine_readable/descriptiles/STATE.a2ml` -- current project state +- `.machine_readable/descriptiles/anchors/ANCHOR.a2ml` -- canonical authority and policy boundary - `.machine_readable/policies/MAINTENANCE-AXES.a2ml` -- canonical axis sequencing and audit requirements - `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml` -- baseline maintenance checklist policy - `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml` -- axis execution approach policy