diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 12fb19f..9837d20 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -1,6 +1,6 @@ - + # Copilot Instructions @@ -33,10 +33,10 @@ ## Banned Languages -- No TypeScript (use ReScript) -- No Node.js / npm / bun (use Deno) +- No TypeScript or ReScript (use AffineScript) +- No Node.js or yarn (use Bun; runtime order Bun > Deno > pnpm > npm, npm only as the last resort) - No Go (use Rust) -- No Python (use Julia or Rust) +- No Python (use AffineScript, Rust or Julia; no exceptions) ## Containers diff --git a/.machine_readable/ai/.clinerules b/.machine_readable/ai/.clinerules index 24a9b30..79c9c7a 100644 --- a/.machine_readable/ai/.clinerules +++ b/.machine_readable/ai/.clinerules @@ -1,6 +1,6 @@ # SPDX-License-Identifier: MPL-2.0 # Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) -# Authoritative source: docs/AI-CONVENTIONS.md +# Authoritative source: docs/practice/AI-CONVENTIONS.adoc # STARTUP: Read 0-AI-MANIFEST.deed first, then chora-registry_chora.deed. @@ -24,10 +24,10 @@ # Rust: transmute (unless FFI with // SAFETY: comment) # BANNED LANGUAGES -# TypeScript -> ReScript -# Node.js / npm / bun -> Deno +# TypeScript, ReScript -> AffineScript +# Node.js / yarn -> Bun (runtime order Bun > Deno > pnpm > npm; npm last resort) # Go -> Rust -# Python -> Julia or Rust +# Python -> AffineScript, Rust or Julia (no exceptions) # CONTAINERS # Runtime: Podman (never Docker). diff --git a/.machine_readable/ai/.cursorrules b/.machine_readable/ai/.cursorrules index fcf0267..ab5c888 100644 --- a/.machine_readable/ai/.cursorrules +++ b/.machine_readable/ai/.cursorrules @@ -1,6 +1,6 @@ # SPDX-License-Identifier: MPL-2.0 # Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) -# Authoritative source: docs/AI-CONVENTIONS.md +# Authoritative source: docs/practice/AI-CONVENTIONS.adoc # Read 0-AI-MANIFEST.deed in the repo root FIRST; it points at the repo deed. @@ -23,10 +23,10 @@ # Rust: transmute (unless FFI with // SAFETY: comment) # BANNED LANGUAGES -# TypeScript -> use ReScript -# Node.js / npm / bun -> use Deno +# TypeScript, ReScript -> use AffineScript +# Node.js / yarn -> use Bun (runtime order Bun > Deno > pnpm > npm; npm last resort) # Go -> use Rust -# Python -> use Julia or Rust +# Python -> use AffineScript, Rust or Julia (no exceptions) # CONTAINERS # Runtime: Podman (never Docker) diff --git a/.machine_readable/ai/.windsurfrules b/.machine_readable/ai/.windsurfrules index b3a79a0..4e6d6ad 100644 --- a/.machine_readable/ai/.windsurfrules +++ b/.machine_readable/ai/.windsurfrules @@ -1,6 +1,6 @@ # SPDX-License-Identifier: MPL-2.0 # Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath) -# Authoritative source: docs/AI-CONVENTIONS.md +# Authoritative source: docs/practice/AI-CONVENTIONS.adoc # STARTUP: Read 0-AI-MANIFEST.deed first, then chora-registry_chora.deed. @@ -24,10 +24,10 @@ # Rust: transmute (unless FFI with // SAFETY: comment) # BANNED LANGUAGES -# TypeScript -> ReScript -# Node.js / npm / bun -> Deno +# TypeScript, ReScript -> AffineScript +# Node.js / yarn -> Bun (runtime order Bun > Deno > pnpm > npm; npm last resort) # Go -> Rust -# Python -> Julia or Rust +# Python -> AffineScript, Rust or Julia (no exceptions) # CONTAINERS # Runtime: Podman (never Docker). diff --git a/.machine_readable/ai/PLACEHOLDERS.adoc b/.machine_readable/ai/PLACEHOLDERS.adoc index 02bc8b4..ddc6fa7 100644 --- a/.machine_readable/ai/PLACEHOLDERS.adoc +++ b/.machine_readable/ai/PLACEHOLDERS.adoc @@ -36,7 +36,7 @@ sed -i "s/{{CURRENT_DATE}}/$(date +%Y-%m-%d)/g" $(grep -rl '{{CURRENT_DATE}}' .) | Placeholder | Description | Example | Files | |---|---|---|---| -| `{{AUTHOR}}` | Full legal name | `Jane Doe` | SPDX headers (all files), MAINTAINERS.md, .mailmap, .reuse/dep5, docs/AI-CONVENTIONS.md | +| `{{AUTHOR}}` | Full legal name | `Jane Doe` | SPDX headers (all files), MAINTAINERS.md, .mailmap, .reuse/dep5, docs/practice/AI-CONVENTIONS.adoc | | `{{AUTHOR_EMAIL}}` | Primary contact email | `jane@example.org` | SPDX headers (all files), .mailmap, .reuse/dep5, .well-known/humans.txt | | `{{AUTHOR_EMAIL_ALT}}` | Previous/secondary email (for .mailmap) | `old@example.com` | .mailmap | | `{{AUTHOR_ORG}}` | Author's organization/affiliation | `Acme University` | project-metadata.k9.ncl | diff --git a/0-AI-MANIFEST.deed b/0-AI-MANIFEST.deed index be15f35..13e651f 100644 --- a/0-AI-MANIFEST.deed +++ b/0-AI-MANIFEST.deed @@ -1,17 +1,15 @@ ;; SPDX-License-Identifier: MPL-2.0 ;; SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath) ;; -;; The machine front door of gv-clade-index (the chora-registry): pointer-only -;; (A7 ruling Q15). It names where to read and carries no facts of its own. +;; The machine front door of the chora-registry (formerly gv-clade-index): +;; pointer-only (A7 ruling Q15). It names where to read and carries no facts +;; of its own. ;; Repository facts are in chora-registry_chora.deed and ;; .machine_readable/descriptiles/STATE.deed; the registry itself is ;; verisim/seed/chora-registry_praxis.deed. It replaces 0-AI-MANIFEST.a2ml, ;; retired 2026-11-14 (docs/history/A2ML-REMOVED.adoc). (repo-deed :schema-version "1.0.0" - :canonical-name "gv-clade-index" - :repo-uuid #uuid"a65b74d8-351a-89d9-a38d-aea470863b03" - :beholding-chora #uuid"0889b37b-defb-831f-973c-e119500db00e" (front-doors :machine "chora-registry_chora.deed" :human "README.adoc")) diff --git a/docs/RSR_OUTLINE.adoc b/docs/RSR_OUTLINE.adoc deleted file mode 100644 index 176b158..0000000 --- a/docs/RSR_OUTLINE.adoc +++ /dev/null @@ -1,295 +0,0 @@ -= RSR Template Repository - -image:[Palimpsest-MPL-1.0,link="https://github.com/hyperpolymath/palimpsest-license"] image:[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-license"] -:toc: -:sectnums: - -// Badges -image:https://img.shields.io/badge/RSR-Infrastructure-cd7f32[RSR Infrastructure] -image:https://img.shields.io/badge/Phase-Maintenance-brightgreen[Phase] -image:https://img.shields.io/badge/Guix-Primary-purple?logo=gnu[Guix] - -== Overview - -**The canonical template for RSR (Rhodium Standard Repository) projects.** - -This repository provides the standardized structure, configuration, and tooling for all RSR-compliant repos. Use it to: - -* Bootstrap new projects with RSR compliance -* Reference the standard directory structure -* Copy configuration templates (Justfile, STATE.a2ml, etc.) - -== Quick Start - -[source,bash] ----- -# Clone the template -git clone https://github.com/hyperpolymath/RSR-template-repo my-project -cd my-project - -# Remove template git history -rm -rf .git -git init - -# Interactive bootstrap — replaces all placeholders -just init - -# Enter development environment -guix shell -D -f guix.scm - -# Validate compliance -just validate-rsr ----- - -== What's Included - -[cols="1,3"] -|=== -|File/Directory |Purpose - -|`.editorconfig` -|Editor configuration (indent, charset) - -|`.gitignore` -|Standard ignore patterns - -|`.gitattributes` -|Line endings, diff drivers, binary detection - -|`.guix-channel` -|Guix channel definition - -|`.well-known/` -|RFC-compliant metadata (security.txt, ai.txt, humans.txt) - -|`.machine_readable/` -|All machine-readable content: state files (6 a2ml), `bot_directives/`, `contractiles/` - -|`docs/` -|Documentation directory - -|`guix.scm` -|Guix package definition - -|`Justfile` -|Task runner with 40+ recipes - -|`Containerfile` -|Container build (Wolfi base, Podman) - -|`LICENSE` -|MPL-2.0 (Palimpsest MPL) - -|`EXHIBIT-A-ETHICAL-USE.txt` -|Ethical use guidelines (LICENSE Exhibit A) - -|`EXHIBIT-B-QUANTUM-SAFE.txt` -|Quantum-safe provenance spec (LICENSE Exhibit B) - -|`README.adoc` -|Project overview - -|`TOPOLOGY.md` -|Architecture diagram and completion dashboard - -|`PLACEHOLDERS.md` -|Template variable reference and replacement guide - -|`0-AI-MANIFEST.a2ml` -|Universal AI agent entry point - -|`AI.a2ml` -|Claude-specific instructions - -|`src/interface/abi/` -|Idris2 ABI definitions (Types, Layout, Foreign) - -|`ffi/zig/` -|Zig FFI implementation - -|`generated/abi/` -|Auto-generated C headers from Idris2 ABI -|=== - -== Justfile Features - -The template Justfile provides: - -* **Combinatoric matrix recipes** for build, test, container, CI -* **Cookbook generation**: `just cookbook` -> `docs/just-cookbook.adoc` -* **Man page generation**: `just man` -> `docs/man/project.1` -* **RSR validation**: `just validate-rsr` -* **STATE.deed review**: `just state-phase` reads the lifecycle phase from - `.machine_readable/descriptiles/STATE.deed`, and `just validate-state` checks - it. There is no `state-touch`: the deed's `:affirmed` date and - `:affirmed-by` record a review, so you change them by hand, and only after - re-checking the values (`docs/history/A2ML-REMOVED.adoc` records where each - came from), never as a timestamp bump. -* **Container support**: `just container-build`, `just container-push` -* **CI matrix**: `just ci-matrix [stage] [depth]` - -=== Key Recipes - -[source,bash] ----- -just # Show all recipes -just help # Detailed help -just info # Project info -just combinations # Show matrix options - -just build # Build (debug) -just test # Run tests -just quality # Format + lint + test -just ci # Full CI pipeline - -just validate # RSR + STATE validation -just docs # Generate all docs -just cookbook # Generate Justfile docs - -just guix-shell # Guix dev environment -just container-build # Build container ----- - -== Directory Structure - -[source] ----- -project/ -├── .editorconfig # Editor settings -├── .gitignore # Git ignore -├── .gitattributes # Line endings, diff drivers -├── .guix-channel # Guix channel -├── .well-known/ # RFC metadata -│ ├── ai.txt -│ ├── humans.txt -│ └── security.txt -├── .machine_readable/ # ALL machine-readable content -│ ├── STATE.a2ml # Project state, progress, blockers -│ ├── META.a2ml # Architecture decisions, governance -│ ├── ECOSYSTEM.a2ml # Ecosystem position, relationships -│ ├── AGENTIC.a2ml # AI agent interaction patterns -│ ├── NEUROSYM.a2ml # Neurosymbolic integration config -│ ├── PLAYBOOK.a2ml # Operational runbook -│ ├── bot_directives/ # Per-bot rules and constraints -│ └── contractiles/ # Policy enforcement contracts -│ ├── k9/ # Security levels (Kennel/Yard/Hunt) -│ ├── dust/Dustfile # Recovery and rollback -│ ├── lust/Intentfile # Future intent declarations -│ ├── must/Mustfile # Invariant checks -│ └── trust/Trustfile.hs # Cryptographic verification -├── docs/ # Documentation -│ ├── CITATIONS.adoc -│ ├── TOPOLOGY-GUIDE.adoc -│ ├── generated/ -│ └── man/ -├── src/interface/abi/ # Idris2 ABI definitions -│ ├── Types.idr -│ ├── Layout.idr -│ └── Foreign.idr -├── ffi/zig/ # Zig FFI implementation -│ ├── build.zig -│ ├── src/main.zig -│ └── test/integration_test.zig -├── generated/abi/ # Auto-generated C headers -├── examples/ # Example code -├── guix.scm # Guix package -├── Justfile # Task runner -├── Containerfile # Container build -├── LICENSE # MPL-2.0 -├── EXHIBIT-A-ETHICAL-USE.txt # Ethical use guidelines -├── EXHIBIT-B-QUANTUM-SAFE.txt # Quantum-safe provenance -├── README.adoc # Overview -├── TOPOLOGY.md # Architecture + completion -├── PLACEHOLDERS.md # Template variable guide -├── 0-AI-MANIFEST.a2ml # Universal AI entry point -└── AI.a2ml # Claude-specific instructions ----- - -== RSR Compliance - -=== Language Tiers - -* **Tier 1** (Gold): Rust, Elixir, Zig, Ada, Haskell, ReScript, Gleam -* **Tier 2** (Silver): Nickel, Guile Scheme, Nix, Idris2, OCaml -* **Infrastructure**: Guix channels, derivations, Julia batch scripts - -=== Required Files - -* `.editorconfig` -* `.gitignore` -* `Justfile` -* `README.adoc` -* `LICENSE` (MPL-2.0) -* `.machine_readable/STATE.a2ml` -* `.well-known/security.txt` -* `.well-known/ai.txt` -* `.well-known/humans.txt` -* `guix.scm` OR `flake.nix` - -=== Prohibited - -* Python outside `salt/` directory -* TypeScript/JavaScript (use ReScript) -* CUE (use Guile/Nickel) -* `Dockerfile` (use `Containerfile`) -* npm, Bun, pnpm, yarn (use Deno) -* Go (use Rust) - -== STATE.a2ml - -The STATE.a2ml file tracks project state: - -[source] ----- -# STATE — Project State Checkpoint -# Format: a2ml (AI-readable markup) - -project: v-graphql -version: 0.1.0 -last-updated: 2026-02-14 -status: active - -phase: implementation -maturity: beta - -ecosystem: - part-of: RSR Framework - depends-on: [] - -milestones: - - name: Initial setup - completion: 100 - - name: Core implementation - completion: 0 ----- - -== Badge Schema - -Generate badges from STATE.a2ml: - -[source,bash] ----- -just badges standard ----- - -See `docs/BADGE_SCHEMA.adoc` for the full badge taxonomy. - -== Ecosystem Integration - -This template is part of: - -* **STATE.a2ml Ecosystem**: Conversation checkpoints -* **RSR Framework**: Repository standards -* **Consent-Aware-HTTP**: .well-known compliance -* **Hypatia**: Neurosymbolic security scanning -* **gitbot-fleet**: Bot orchestration - -== License - -SPDX-License-Identifier: CC-BY-SA-4.0 - -== Links - -* https://github.com/hyperpolymath/elegant-STATE[elegant-STATE] - STATE tooling -* https://github.com/hyperpolymath/conative-gating[conative-gating] - Policy enforcement -* https://rhodium.sh[Rhodium Standard] - RSR documentation