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
2 changes: 0 additions & 2 deletions deno/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ implementation
implementation
* https://github.com/hyperpolymath/deed-ecosystem/tree/main/gleam[gleam/] — Gleam
implementation
* https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] —
Tree-sitter grammar
* https://github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml[members/tooling/vscode-a2ml/] — VS Code
extension

Expand Down
1 change: 0 additions & 1 deletion ex/EXPLAINME.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ The `A2ML.Types.TrustLevel` enum in `lib/a2ml/types.ex` defines a four-tier hier
a2ml_ex is part of the A2ML ecosystem, which includes:

* link:https://github.com/hyperpolymath/deed-ecosystem/tree/main/deno[deno/] — Deno/AffineScript implementation (primary)
* link:https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] — Tree-sitter grammar for syntax highlighting
* link:https://github.com/hyperpolymath/deed-ecosystem/tree/main/haskell[haskell/] — Haskell implementation
* link:https://github.com/hyperpolymath/standards[standards] — A2ML spec (K9 service specification)

Expand Down
2 changes: 0 additions & 2 deletions ex/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,6 @@ implementation
implementation
* https://github.com/hyperpolymath/deed-ecosystem/tree/main/gleam[gleam/] — Gleam
implementation
* https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] —
Tree-sitter grammar
* https://github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml[members/tooling/vscode-a2ml/] — VS Code
extension

Expand Down
4 changes: 2 additions & 2 deletions ex/docs/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,6 @@ When you make a non-obvious design decision, write it down:

== Reporting issues

* Bugs in `a2ml_ex`: file at `hyperpolymath/deed-ecosystem/issues`.
* Bugs in `a2ml_ex`: file at https://github.com/hyperpolymath/deed-ecosystem/issues.
* Estate-wide concerns (policy, conventions, CI): file at
`hyperpolymath/standards/issues`.
https://github.com/hyperpolymath/standards/issues.
4 changes: 2 additions & 2 deletions gleam/docs/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,6 @@ When you make a non-obvious design decision, write it down:

== Reporting issues

* Bugs in `a2ml_gleam`: file at `hyperpolymath/deed-ecosystem/issues`.
* Bugs in `a2ml_gleam`: file at https://github.com/hyperpolymath/deed-ecosystem/issues.
* Estate-wide concerns (policy, conventions, CI): file at
`hyperpolymath/standards/issues`.
https://github.com/hyperpolymath/standards/issues.
2 changes: 1 addition & 1 deletion haskell/EXPLAINME.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ scaffolding for a future integration milestone.
|===
| Technology | Also Used In

| **A2ML format** | https://github.com/hyperpolymath/deed-ecosystem/tree/main/rs[rs/] (Rust binding), https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] (Lua Pandoc reader), https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] (grammar)
| **A2ML format** | https://github.com/hyperpolymath/deed-ecosystem/tree/main/rs[rs/] (Rust binding)

| **Haskell / GHC + cabal** | https://github.com/hyperpolymath/nextgen-languages[nextgen-languages] (Scaffoldia CLI, AffineScript compiler), https://github.com/hyperpolymath/hypatia[hypatia] (rule modules)

Expand Down
2 changes: 0 additions & 2 deletions haskell/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ cabal test

* https://github.com/hyperpolymath/deed-ecosystem/tree/main/rs[rs/] — Rust
implementation
* https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] — Pandoc Lua
reader/writer

== License

Expand Down
5 changes: 2 additions & 3 deletions rs/EXPLAINME.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ into a `Vec<Block>`. The renderer in `src/renderer.rs` serialises the same
handle nested block structures beyond one level of block-quote recursion.
Multi-line directives (as used in the Haskell variant with `@name: ... @end`
blocks) are not yet supported; directives here are single-line `@name value`
pairs only. No HTML or PDF output is built in — use `pandoc-a2ml` (the Lua
reader in `hyperpolymath/pandoc-a2ml`) for format conversion.
pairs only. No HTML or PDF output is built in.

- Implementation: `src/parser.rs` (parse, parse_file), `src/renderer.rs` (render)
- Core types: `src/types.rs` (Document, Block, Inline, Directive, Attestation, TrustLevel, Manifest)
Expand Down Expand Up @@ -113,7 +112,7 @@ MPL-2.0 where the platform permits it.
|===
| Technology | Also Used In

| **A2ML format** | https://github.com/hyperpolymath/deed-ecosystem/tree/main/haskell[haskell/] (Haskell binding), https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] (Lua reader), https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] (grammar)
| **A2ML format** | https://github.com/hyperpolymath/deed-ecosystem/tree/main/haskell[haskell/] (Haskell binding)

| **Rust + thiserror** | https://github.com/hyperpolymath/panic-attacker[panic-attacker], https://github.com/hyperpolymath/patch-bridge[patch-bridge], https://github.com/hyperpolymath/protocol-squisher[protocol-squisher]

Expand Down
2 changes: 0 additions & 2 deletions rs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,6 @@ Signature verification belongs in the Groove protocol stack.

== Related

* https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] — Pandoc
reader/writer for A2ML
* https://github.com/hyperpolymath/deed-ecosystem/tree/main/haskell[haskell/] — Haskell
implementation

Expand Down
48 changes: 2 additions & 46 deletions showcase/content/getting-started.adoc
Original file line number Diff line number Diff line change
@@ -1,34 +1,15 @@
== Get Started

A step-by-step guide to creating your first A2ML manifest, validating
it, and integrating it into your project.
A step-by-step guide to creating your first A2ML manifest and
integrating it into your project.

=== Prerequisites

* https://pandoc.org/installing.html[Pandoc] 3.0 or later
* Git (for cloning the tooling)
* A text editor (VS Code recommended for syntax highlighting)

'''''

=== Install pandoc-a2ml

Clone the pandoc-a2ml repository and note the path to the Lua scripts.
No compilation needed — the reader, writer, and filter are pure Lua.

[source,bash]
----
git clone https://github.com/hyperpolymath/pandoc-a2ml.git
cd pandoc-a2ml
----

The key files are: - `+a2ml-reader.lua+` — reads `+.a2ml+` files into
Pandoc’s AST - `+a2ml-writer.lua+` — writes Pandoc AST as `+.a2ml+`
output - `+a2ml-filter.lua+` — Lua filter for attestation processing

You can either add these to your Pandoc data directory
(`+~/.local/share/pandoc/+`) or reference them by path.

=== Install the VS Code Extension

For syntax highlighting while editing `+.a2ml+` files:
Expand Down Expand Up @@ -89,29 +70,6 @@ No AI agents currently operate on this repository.
@end
....

=== Validate with Pandoc

Check that your manifest parses correctly by converting it to HTML:

[source,bash]
----
pandoc -f path/to/a2ml-reader.lua 0-AI-MANIFEST.a2ml -o manifest.html
----

If the file is well-formed, Pandoc will produce clean HTML output. Open
`+manifest.html+` in a browser to verify the structure.

For deeper validation using the A2ML filter (checks attestation
structure):

[source,bash]
----
pandoc -f path/to/a2ml-reader.lua \
--lua-filter path/to/a2ml-filter.lua \
0-AI-MANIFEST.a2ml \
-o validated.html
----

=== Add Machine-Readable Metadata

For full Rhodium Standard compliance, create the `+.machine_readable/+`
Expand Down Expand Up @@ -207,7 +165,5 @@ directives and fields
* Browse link:examples.html[Examples] for real-world patterns
* Explore link:integrations.html[Integrations] for editor and CI tooling
* Check out the source repositories:
** https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml]
** https://github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml[members/tooling/vscode-a2ml/]
** https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml]
** https://github.com/hyperpolymath/pandoc-k9[pandoc-k9]
6 changes: 0 additions & 6 deletions showcase/content/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,8 @@ multi-agent trust networks

A2ML is not a paper specification. It ships with real, working tools:

* *https://pandoc.org[Pandoc]* reader, writer, filter, and template via
https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] — convert A2ML
to HTML, PDF, Markdown, and 40+ other formats
* *https://code.visualstudio.com[VS Code]* syntax highlighting via
https://github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml[members/tooling/vscode-a2ml/]
* *https://tree-sitter.github.io[Tree-sitter]* grammar via
https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] —
works in Neovim, Helix, Zed, and GitHub
* *GitHub Linguist* — language detection (submission pending)

== Part of a Larger Ecosystem
Expand Down
61 changes: 1 addition & 60 deletions showcase/content/integrations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,6 @@ ecosystems. This is not a roadmap — these tools exist today.

'''''

=== Pandoc [.badge .badge-live]#Live#

Full Pandoc integration via
https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml]: custom
reader, writer, Lua filter, and HTML template.

Convert A2ML to any of Pandoc’s 40+ output formats (HTML, PDF, DOCX,
LaTeX, Markdown, reStructuredText, EPUB, and more), or convert _from_
any Pandoc input format into A2ML.

[source,bash]
----
# Read A2ML, output HTML
pandoc -f a2ml-reader.lua manifest.a2ml -o manifest.html

# Read A2ML, output PDF
pandoc -f a2ml-reader.lua manifest.a2ml -o manifest.pdf

# Convert Markdown to A2ML
pandoc README.md -t a2ml-writer.lua -o README.a2ml

# Apply the A2ML filter for attestation validation
pandoc -f a2ml-reader.lua --lua-filter a2ml-filter.lua manifest.a2ml -o report.html
----

*Install:* Clone the repo and add the Lua scripts to your Pandoc data
directory, or reference them by path.

*Repository:*
https://github.com/hyperpolymath/pandoc-a2ml[github.com/hyperpolymath/pandoc-a2ml]

=== VS Code [.badge .badge-live]#Live#

Syntax highlighting, bracket matching, and snippet support for `+.a2ml+`
Expand All @@ -53,23 +22,6 @@ VSIX.
*Repository:*
https://github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml[github.com/hyperpolymath/deed-ecosystem/tree/main/members/tooling/vscode-a2ml]

=== Tree-sitter [.badge .badge-live]#Live#

A https://tree-sitter.github.io[tree-sitter] grammar for A2ML, enabling
syntax highlighting and structural queries in any editor that supports
tree-sitter.

Works with: - *Neovim* (via nvim-treesitter) - *Helix* (built-in
tree-sitter support) - *Zed* (built-in tree-sitter support) - *GitHub*
(syntax highlighting in code views, via tree-sitter) - *Emacs* (via
tree-sitter-langs)

The grammar parses the full A2ML syntax including nested directive
blocks, attestation fields, and inline formatting.

*Repository:*
https://github.com/hyperpolymath/tree-sitter-a2ml[github.com/hyperpolymath/tree-sitter-a2ml]

=== GitHub Linguist [.badge .badge-pending]#Pending#

A pull request to add A2ML to
Expand All @@ -81,7 +33,7 @@ preparation. Once merged, GitHub will:
* Apply syntax highlighting using the tree-sitter grammar
* Recognise `+application/vnd.a2ml+` as a registered media type

=== K9 Validators [.badge .badge-live]#Live#
=== K9 Validators [.badge .badge-pending]#Pending#

https://github.com/hyperpolymath/pandoc-k9[pandoc-k9] provides
contractile validation for A2ML files. K9 validators enforce structural
Expand All @@ -98,17 +50,6 @@ validation.
*Repository:*
https://github.com/hyperpolymath/pandoc-k9[github.com/hyperpolymath/pandoc-k9]

=== LuaRocks [.badge .badge-live]#Live#

The A2ML Pandoc components are available as a Lua library via
https://luarocks.org[LuaRocks], making it straightforward to integrate
A2ML parsing into any Lua-based toolchain.

[source,bash]
----
luarocks install pandoc-a2ml
----

=== Hypatia CI/CD Scanner [.badge .badge-live]#Live#

https://github.com/hyperpolymath/hypatia[Hypatia] consumes A2ML
Expand Down
25 changes: 3 additions & 22 deletions showcase/content/specification.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

A2ML (Attested Markup Language) is a text-based document format that
combines human-readable markup with machine-verifiable attestation
blocks. This page describes the format as currently implemented in the
https://github.com/hyperpolymath/pandoc-a2ml[pandoc-a2ml] toolchain.
blocks. This page describes the format as currently implemented across
the reference implementations in
https://github.com/hyperpolymath/deed-ecosystem[deed-ecosystem].

=== File Format

Expand Down Expand Up @@ -258,23 +259,3 @@ Standard], A2ML files live in the `+.machine_readable/+` directory:

The top-level `+0-AI-MANIFEST.a2ml+` serves as the entry point that all
AI agents must read first.

=== Pandoc Integration

A2ML is a first-class Pandoc format. Convert between A2ML and any
Pandoc-supported format:

[source,bash]
----
# A2ML to HTML
pandoc -f a2ml-reader.lua input.a2ml -o output.html

# A2ML to PDF (via LaTeX)
pandoc -f a2ml-reader.lua input.a2ml -o output.pdf

# Markdown to A2ML
pandoc input.md -t a2ml-writer.lua -o output.a2ml

# A2ML to A2ML (normalise)
pandoc -f a2ml-reader.lua input.a2ml -t a2ml-writer.lua -o normalised.a2ml
----
Loading