Skip to content

Commit b4a9d66

Browse files
hyperpolymathclaude
andcommitted
docs: post-canon reference + factual fixes
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) <noreply@anthropic.com>
1 parent ac1392a commit b4a9d66

5 files changed

Lines changed: 33 additions & 26 deletions

File tree

.machine_readable/ai/README.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
13
= AI Guidance Directory
24

35
Put AI-facing instructions in this folder.
@@ -14,9 +16,9 @@ Avoid scattering agent instruction files around the repo root.
1416

1517
Recommended machine read order:
1618

17-
* `.machine_readable/anchors/ANCHOR.a2ml`
19+
* `.machine_readable/descriptiles/anchors/ANCHOR.a2ml`
1820
* `.machine_readable/policies/MAINTENANCE-AXES.a2ml`
1921
* `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml`
2022
* `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml`
21-
* `.machine_readable/STATE.a2ml`
22-
* `.machine_readable/META.a2ml`
23+
* `.machine_readable/descriptiles/STATE.a2ml`
24+
* `.machine_readable/descriptiles/META.a2ml`

.machine_readable/bot_directives/README.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// SPDX-License-Identifier: CC-BY-SA-4.0
2-
// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
3-
= Agent Instructions
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
= Bot Directives
44
:toc: preamble
55

66
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
3232
== Relationship to Other Files
3333

3434
* `AGENTIC.a2ml` says WHAT agents can do (permissions, gating)
35-
* `agent_instructions/` says HOW agents should work (methodology)
36-
* `bot_directives/` says what the gitbot-fleet does (fleet-specific)
35+
* `bot_directives/` (this directory) says HOW agents should work methodology
36+
and fleet-wide directives (formerly `agent_instructions/`)
3737
* `CLAUDE.md` says how Claude specifically should work (Claude-specific)
3838

3939
== Reference

ROADMAP.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
23
= A2ml Validate Action Roadmap
34

45
== Current Status
56

6-
Initial development phase.
7+
v1.0.0 released 2026-05-29 — stable. See `CHANGELOG.md`.
78

89
== Milestones
910

10-
=== v0.1.0 - Foundation
11-
* [ ] Core functionality
12-
* [ ] Basic documentation
13-
* [ ] CI/CD pipeline
11+
=== v0.1.0 - Foundation (released)
12+
* [x] Core functionality
13+
* [x] Basic documentation
14+
* [x] CI/CD pipeline
1415

15-
=== v1.0.0 - Stable Release
16-
* [ ] Full feature set
17-
* [ ] Comprehensive tests
18-
* [ ] Production ready
16+
=== v1.0.0 - Stable Release (released 2026-05-29)
17+
* [x] Full feature set
18+
* [x] Comprehensive tests
19+
* [x] Production ready
1920

2021
== Future Directions
2122

TEST-NEEDS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
15
# TEST-NEEDS.md — a2ml-validate-action
26

37
## CRG Grade: C — ACHIEVED 2026-04-04
@@ -7,7 +11,7 @@
711
| Category | Count | Notes |
812
|----------|-------|-------|
913
| Test directories | 2 | Location(s): /verification/tests, /tests |
10-
| CI workflows | 21 | Running tests on GitHub Actions |
14+
| CI workflows | 14 | Running tests on GitHub Actions |
1115
| Tests | Present | Configured in CI workflows |
1216

1317
## What's Covered

docs/practice/AI-CONVENTIONS.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
// SPDX-License-Identifier: CC-BY-SA-4.0
2+
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
13
= AI Conventions
2-
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
3-
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->
44

55
# AI Conventions (Authoritative Source)
66

@@ -10,12 +10,12 @@ Per-tool config files (.cursorrules, .clinerules, etc.) reference this document.
1010
## Session Startup
1111

1212
1. Read `0-AI-MANIFEST.a2ml` FIRST (mandatory gatekeeper).
13-
2. Read `.machine_readable/STATE.a2ml` for current status and blockers.
14-
3. Read `.machine_readable/anchors/ANCHOR.a2ml` for canonical authority boundaries.
13+
2. Read `.machine_readable/descriptiles/STATE.a2ml` for current status and blockers.
14+
3. Read `.machine_readable/descriptiles/anchors/ANCHOR.a2ml` for canonical authority boundaries.
1515
4. Read `.machine_readable/policies/MAINTENANCE-AXES.a2ml` for maintenance/audit sequencing.
1616
5. Read `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml` for baseline controls.
1717
6. Read `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml` for execution order.
18-
7. Read `.machine_readable/AGENTIC.a2ml` for agent constraints.
18+
7. Read `.machine_readable/descriptiles/AGENTIC.a2ml` for agent constraints.
1919

2020
## License
2121

@@ -29,7 +29,7 @@ Per-tool config files (.cursorrules, .clinerules, etc.) reference this document.
2929

3030
- Name: **Jonathan D.A. Jewell**
3131
- Email: **j.d.a.jewell@open.ac.uk**
32-
- Copyright: `Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>`
32+
- Copyright: `Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>`
3333

3434
## State Files
3535

@@ -77,9 +77,9 @@ Use `just` (justfile) for all build, test, lint, and format tasks.
7777
## References
7878

7979
- `0-AI-MANIFEST.a2ml` -- universal AI entry point
80-
- `.machine_readable/AGENTIC.a2ml` -- agent permissions and constraints
81-
- `.machine_readable/STATE.a2ml` -- current project state
82-
- `.machine_readable/anchors/ANCHOR.a2ml` -- canonical authority and policy boundary
80+
- `.machine_readable/descriptiles/AGENTIC.a2ml` -- agent permissions and constraints
81+
- `.machine_readable/descriptiles/STATE.a2ml` -- current project state
82+
- `.machine_readable/descriptiles/anchors/ANCHOR.a2ml` -- canonical authority and policy boundary
8383
- `.machine_readable/policies/MAINTENANCE-AXES.a2ml` -- canonical axis sequencing and audit requirements
8484
- `.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml` -- baseline maintenance checklist policy
8585
- `.machine_readable/policies/SOFTWARE-DEVELOPMENT-APPROACH.a2ml` -- axis execution approach policy

0 commit comments

Comments
 (0)