Skip to content

docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 1 commit into from
Jun 25, 2026
Merged

docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
66 changes: 0 additions & 66 deletions README.adoc
View file
Open in desktop

This file was deleted.

93 changes: 49 additions & 44 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,68 +1,73 @@
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)

// SPDX-License-Identifier: CC-BY-SA-4.0
= a2ml-rs
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
:toc:
:toc-placement: preamble
<!--
SPDX-License-Identifier: CC-BY-SA-4.0
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->

Rust parser and renderer for A2ML (Attested Markup Language) — the
structured markup format used across the hyperpolymath estate for AI-agent
communication, machine state files, and provenance-tracked documentation.
structured markup format used across the hyperpolymath estate for
AI-agent communication, machine state files, and provenance-tracked
documentation.

# Overview

== Overview
A2ML extends a Markdown-like surface syntax with two first-class
constructs:

A2ML extends a Markdown-like surface syntax with two first-class constructs:
- `@directives` — single-line machine-readable metadata prefixed with
`@`

* `@directives` — single-line machine-readable metadata prefixed with `@`
* `!attest` blocks — record identity, role, and trust-level on any piece
of content, enabling provenance tracking across AI-agent and human review chains
- `!attest` blocks — record identity, role, and trust-level on any piece
of content, enabling provenance tracking across AI-agent and human
review chains

`a2ml-rs` implements:

* `src/parser.rs` — line-oriented state machine: headings, directives,
attestation blocks, fenced code, block quotes, ordered/unordered lists.
Entry points: `parse()` and `parse_file()`.
* `src/renderer.rs` — serialises a `Document` AST back to canonical A2ML,
making round-trips deterministic.
* `src/types.rs` — core types: `Document`, `Block`, `Inline`, `Directive`,
`Attestation`, `TrustLevel` (Unverified → Automated → Reviewed → Verified),
`Manifest`.
* `src/error.rs` — `A2mlError`: `ParseError`, `Io`, `RenderError`.
- `src/parser.rs` — line-oriented state machine: headings, directives,
attestation blocks, fenced code, block quotes, ordered/unordered
lists. Entry points: `parse()` and `parse_file()`.

- `src/renderer.rs` — serialises a `Document` AST back to canonical
A2ML, making round-trips deterministic.

- `src/types.rs` — core types: `Document`, `Block`, `Inline`,
`Directive`, `Attestation`, `TrustLevel` (Unverified → Automated →
Reviewed → Verified), `Manifest`.

The crate root is `#![forbid(unsafe_code)]`. Dependencies: `serde`/`serde_derive`
for serialisation, `thiserror` for error types, `criterion` for benchmarks only.
- `src/error.rs` — `A2mlError`: `ParseError`, `Io`, `RenderError`.

== Usage
The crate root is `#![forbid(unsafe_code)]`. Dependencies:
`serde`/`serde_derive` for serialisation, `thiserror` for error types,
`criterion` for benchmarks only.

[source,rust]
----
# Usage

```rust
use a2ml::{parse, render};

let doc = parse(input_str)?;
let output = render(&doc)?;
----

== Attestation Trust Levels
```

[cols="1,3"]
|===
| Level | Meaning
# Attestation Trust Levels

| `Unverified` | No review — raw agent or tool output
| `Automated` | Processed by a pipeline without human review
| `Reviewed` | Human-reviewed (claimed, not cryptographically proved)
| `Verified` | Formally verified or cryptographically attested
|===
| Level | Meaning |
|--------------|--------------------------------------------------------|
| `Unverified` | No review — raw agent or tool output |
| `Automated` | Processed by a pipeline without human review |
| `Reviewed` | Human-reviewed (claimed, not cryptographically proved) |
| `Verified` | Formally verified or cryptographically attested |

Attestations are syntactic declarations, not cryptographic signatures.
Signature verification belongs in the Groove protocol stack.

== Related
# Related

- [pandoc-a2ml](https://github.com/hyperpolymath/pandoc-a2ml) — Pandoc
reader/writer for A2ML

* link:https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] — Pandoc reader/writer for A2ML
* link:https://github.com/hyperpolymath/a2ml-haskell[a2ml-haskell] — Haskell implementation
- [a2ml-haskell](https://github.com/hyperpolymath/a2ml-haskell) —
Haskell implementation

== License
# License

MPL-2.0. See link:LICENSE[LICENSE].
MPL-2.0. See [LICENSE](LICENSE).
Loading