Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .machine_readable/ai/README.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= AI Guidance Directory

Put AI-facing instructions in this folder.
Expand All @@ -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`
8 changes: 4 additions & 4 deletions .machine_readable/bot_directives/README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk>
= Agent Instructions
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Bot Directives
:toc: preamble

Methodology-aware configuration for AI agents. Read by any AI agent
Expand Down Expand Up @@ -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
Expand Down
19 changes: 10 additions & 9 deletions ROADMAP.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= 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

Expand Down
6 changes: 5 additions & 1 deletion TEST-NEEDS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
# TEST-NEEDS.md — a2ml-validate-action

## CRG Grade: C — ACHIEVED 2026-04-04
Expand All @@ -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
Expand Down
18 changes: 9 additions & 9 deletions docs/practice/AI-CONVENTIONS.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= AI Conventions
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) <j.d.a.jewell@open.ac.uk> -->

# AI Conventions (Authoritative Source)

Expand All @@ -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

Expand All @@ -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) <j.d.a.jewell@open.ac.uk>`
- Copyright: `Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>`

## State Files

Expand Down Expand Up @@ -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
Loading