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
6 changes: 6 additions & 0 deletions .github/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .github

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .github/copilot/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .github/copilot

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .github/hooks/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .github/hooks

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .github/scripts/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .github/scripts

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .github/workflows/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .github/workflows

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/compliance/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/compliance

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/compliance/reuse/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/compliance/reuse

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/compliance/rust/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/compliance/rust

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/configs/git-cliff/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/configs/git-cliff

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/contractiles/bust/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/contractiles/bust

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/contractiles/dust/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/contractiles/dust

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/integrations/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/integrations

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/scripts/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/scripts

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/scripts/maintenance/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/scripts/maintenance

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions .machine_readable/self-validating/examples/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= .machine_readable/self-validating/examples

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
8 changes: 8 additions & 0 deletions 0-AI-MANIFEST.deed
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,18 @@ agents = [
{ name = "VIBE", role = "UI/frontend, PanLL panels, ReScript components, theming, rapid prototyping" },
]

[startup]
read-first = ["0-AI-MANIFEST.deed", ".machine_readable/6a2/STATE.deed", "docs/onboarding/SETUP.adoc"]
estate = "AsciiDoc + .deed; not README.md or .a2ml"
js-reach = "Bun, Deno, pnpm, npm"
no-core-checker = true
do-not-close-issues = ["5", "6", "7", "8", "9", "10", "11"]

[policy]
rules = [
"Do not duplicate tasks across sections. If a task needs multiple LLMs, note the handoff.",
"Update THIS file during sessions. Do NOT recreate per-repo TODO files.",
"Gatekeeper kv is not DEED ABNF; do not pretend [metadata] is a repo-deed.",
]

[work-allocation]
Expand Down
6 changes: 6 additions & 0 deletions LICENSES/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= LICENSES

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions build/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= build

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions build/just/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= build/just

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions docs-template/decisions/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs-template/decisions

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
2 changes: 1 addition & 1 deletion docs/QUICKSTART.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Get up and running in 60 seconds.
* Git 2.40+
* just (command runner)
* Idris2 0.7.0+
* Zig 0.16.0+
* Zig 0.15.1

== Get panoply Running

Expand Down
6 changes: 6 additions & 0 deletions docs/architecture/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/architecture

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions docs/assets/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/assets

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions docs/github/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/github

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions docs/legal/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/legal

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
6 changes: 6 additions & 0 deletions docs/onboarding/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/onboarding

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
45 changes: 45 additions & 0 deletions docs/onboarding/SETUP.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Setup — four approaches
:revdate: 2026-09-20

Panoply is a **library** (Idris2 ABI + Zig FFI). There is no `panoply` binary.
Zig **0.15.1** (not 0.16). Idris2 optional for FFI-only work.

== 1. AI-assisted

Paste this to an agent with repo access:

----
Read 0-AI-MANIFEST.deed, then .machine_readable/6a2/STATE.deed.
Estate: AsciiDoc + .deed (not README.md / .a2ml). JS reach: Bun → Deno → pnpm → npm.
No Python/Go. Do not claim a Core checker. just deps && just test-smoke.
If idris2 is missing, skip ABI typecheck; zig tests must pass.
Do not commit secrets. Do not close issues #5–#11.
----

== 2. Raw (manual)

. Git 2.40+, just, Zig 0.15.1, optionally Idris2 0.7+
. `git clone https://github.com/hyperpolymath/panoply && cd panoply`
. `cd src/interface/ffi && zig build test`
. Optional: `idris2 --build src/interface/abi.ipkg`

== 3. Just

----
just deps
just test-smoke
just spec-tests
just p2p
just e2e # SKIP idris2 if absent
just proof-check-idris2 # SKIP without idris2
----

There is no `just setup` that downloads toolchains; Guix is `just guix-shell`.

== 4. Launcher

No desktop GUI. The launcher is **`just`**. Helpers live in `launcher/`
(path resolve / gui-error) for a future GUI. Do not expect
`/.well-known/groove` (port 0, surfaces off).
6 changes: 6 additions & 0 deletions docs/proposals/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/proposals

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
38 changes: 38 additions & 0 deletions docs/reports/PHASE-6-DOCS.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Phase 6 — documentation, wiki, bot readability
:revdate: 2026-09-20

== 6.1 README layers

Estate law: **README.adoc**, not `README.md` (banned for general docs).
Thin AsciiDoc READMEs added for directories that lacked one.

== 6.2 AI manifests

Root `0-AI-MANIFEST.deed` (gatekeeper kv, not DEED ABNF) +
`.machine_readable/0.1-AI-MANIFEST.deed`. Layer `0.1`/`0.2` files already
exist (~100). Do not duplicate `0.1` at git root (root-shape allowlist).

== 6.3 AFFIRMATION

Present at root, profile A. **Draft until `-S`.** Do not invent a new
SHA in this PR.

== 6.4 .deed

No `.a2ml` files remain. Gatekeeper kv still not ABNF.

== 6.5 Security/quality

`docs/reports/security/REMEDIATION.adoc`. CRG X. #11 Hypatia.

== 6.6 Setup

`docs/onboarding/SETUP.adoc` — AI prompt, raw, just, launcher=`just`.
QUICKSTART Zig pin corrected to 0.15.1.

== 6.7 Wiki

GitHub wiki off. `docs/wikis/PLAN.adoc` + users/maintainers/developers.
3-ply / span 7. berrywiki not vendored.
6 changes: 6 additions & 0 deletions docs/reports/audit/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/reports/audit

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
17 changes: 17 additions & 0 deletions docs/reports/security/REMEDIATION.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Security findings — remediation
:revdate: 2026-09-20

No product CVE tracker: panoply has no network server.

| Finding | Plan |
|---|---|
| Hypatia FPs on RSR scaffolding | Issue #11 — precise `.hypatia-ignore` when a findings dump exists |
| Secret scanning | Already enabled + push protection |
| Dependabot | Enabled |
| PAT in agent sessions | Owner rotates after sessions; never commit |
| Groove REST lie | Fixed Phase 3 (surfaces off) |

Quality: CRG **X** until unit+smoke+RSR evidence is recorded without
vacuous passes. Taxonomy N/A rows in `docs/status/TEST-NEEDS.adoc`.
6 changes: 6 additions & 0 deletions docs/status/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= docs/status

Layer README (AsciiDoc; estate forbids README.md here).
Parent: repository panoply. See `/README.adoc` and `/0-AI-MANIFEST.deed`.
1 change: 1 addition & 0 deletions docs/status/ROADMAP.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ Design phase. Charter + RSR spine + Core/Evidence *specs*. No Core checker.
* [ ] Proofs: ABI-2..5 typecheck in CI with idris2; Core preservation after a checker
* [ ] Tests: PBT/FUZ/TSF when Core parser exists; no fake harnesses
* [ ] Benches: FFI-overhead once there is a hot path; Six Sigma baselines then
* [ ] Optional berrywiki host; in-tree `docs/wikis/` is the wiki (Phase 6 scaffold)
43 changes: 43 additions & 0 deletions docs/wikis/PLAN.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Wiki plan (berrywiki-shaped, 3-ply / span 7)
:revdate: 2026-09-20

GitHub wiki is **off** (estate). Content lives in `docs/wikis/`.
`metadatastician/berrywiki` is a Cargo wiki app — **not vendored**.
This tree follows its audience split, not its Rust runtime.

== Constraints

* Max **3-ply** nesting (`docs/wikis/{audience}/{page}`)
* Max **span 7** at each layer

== Layer 0 (≤7)

. xref:README.adoc[Home]
. xref:users/README.adoc[Users]
. xref:maintainers/README.adoc[Maintainers]
. xref:developers/README.adoc[Developers]
. xref:../onboarding/SETUP.adoc[Setup]
. xref:GLOSSARY.adoc[Glossary]
. xref:../status/ROADMAP.adoc[Status]

== Layer 1 — Users (≤7)

Reading a refused manifest; what is not guaranteed; Core vs surface;
evidence kinds; backends as contracts; no GUI; FAQ.

== Layer 1 — Maintainers (≤7)

RSR shape; Guix not Nix; CI rulesets; Hypatia ignore; deed vs TOML
gatekeepers; CRG X honesty; release (none yet).

== Layer 1 — Developers (≤7)

ABI Idris2; FFI Zig; API stub; adding a projection; adding a backend;
proofs Idris2-only; tests taxonomy N/A rules.

== Phase 8

Optional berrywiki deploy if a hosted wiki is wanted. Not required for
in-tree `docs/wikis/`.
9 changes: 5 additions & 4 deletions docs/wikis/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
:toc: preamble
:icons: font

The long-form, community knowledge hub for Panoply. For the structured,
role-divided learning path, start with xref:../guide/README.adoc[the Learning
Path]; this wiki is for deep-dives, cross-cutting notes, and the shared
vocabulary.
GitHub wiki is off. In-tree hub: this directory (max 3-ply, span 7).
Plan: xref:PLAN.adoc[PLAN.adoc]. Audiences: xref:users/README.adoc[users],
xref:maintainers/README.adoc[maintainers],
xref:developers/README.adoc[developers]. Setup:
xref:../onboarding/SETUP.adoc[SETUP].

== Start here

Expand Down
8 changes: 8 additions & 0 deletions docs/wikis/developers/README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
= Wiki — developers

ABI = Idris2 `src/interface/Abi`. FFI = Zig `src/interface/ffi`.
API = fail-closed stub `src/api/zig/adapter.zig`. Proofs: Idris2 only.
JS reach: Bun → Deno → pnpm → npm. No Python/Go.
See xref:../../onboarding/SETUP.adoc[setup].
Loading
Loading