diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f9a724b..4714ad5 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,4 @@ # SPDX-License-Identifier: MPL-2.0 -# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners - -# All files in the repository -* @hyperpolymath +# Solo-maintained hyperpolymath repo: no owner lines by policy. +# See hyperpolymath/standards CODEOWNERS-POLICY.adoc (Rule 1). +# Sole-maintainer review is moot; SPDX headers carry attribution. diff --git a/0-AI-MANIFEST.a2ml b/0-AI-MANIFEST.a2ml index b4c734a..06ca859 100644 --- a/0-AI-MANIFEST.a2ml +++ b/0-AI-MANIFEST.a2ml @@ -112,3 +112,20 @@ (rss IN CNAME example.com.) ; RSS feed aggregator (proxied) ) ) + + + +## PRIORITY ACTION — this repository is not fully initialised + +9 substitution token(s) still have no value. **Read +`REQUIRES_INITIALISATION.md` in the repository root before doing anything +else here** — it lists every outstanding token, what it means, and which +files it belongs in. + +Do not fabricate values for them, and do not delete the sections that +contain them to quiet a gate. They are unfilled because they need a +decision, not because they were overlooked. Resolve what you legitimately +can, leave the rest, and delete `REQUIRES_INITIALISATION.md` only when +nothing outstanding remains. + + diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md deleted file mode 100644 index 607e3d8..0000000 --- a/ARCHITECTURE.md +++ /dev/null @@ -1,47 +0,0 @@ -# Architecture - -## Overview - -This repository follows a modular, maintainable architecture designed for clarity, scalability, and long-term sustainability. - -## Directory Structure - -``` -. -├── src/ # Source code -├── tests/ # Test suites -├── docs/ # Documentation -├── scripts/ # Utility scripts -├── config/ # Configuration files -├── LICENSE # License file -├── LICENSES/ # Full license texts -└── README.adoc # Project documentation -``` - -## Design Principles - -- **Separation of Concerns**: Each module has a single responsibility -- **Testability**: Code is written to be easily testable -- **Documentation**: All public APIs are documented -- **Configuration**: Environment-specific settings are externalized - -## Dependencies - -- External dependencies are minimized and clearly declared -- Version pinning is used for reproducibility - -## Security Considerations - -- Sensitive data is never committed to the repository -- Secrets are managed through environment variables or secure vaults -- Regular dependency audits are performed - -## Maintainability - -- Code follows consistent style guidelines -- Pull requests require review and CI checks -- Issues and discussions are tracked transparently - ---- - -*Last updated: 2026-07-18* diff --git a/PROOF-NEEDS.md b/PROOF-NEEDS.md index 8950320..fa63d16 100644 --- a/PROOF-NEEDS.md +++ b/PROOF-NEEDS.md @@ -4,7 +4,7 @@ Template ABI removed -- was creating false impression of formal verification. The removed files (Types.idr, Layout.idr, Foreign.idr) contained only RSR template -scaffolding with unresolved {{PROJECT}}/{{AUTHOR}} placeholders and no domain-specific proofs. +scaffolding with unresolved AERIE/Jonathan D.A. Jewell placeholders and no domain-specific proofs. When this project needs formal ABI verification, create domain-specific Idris2 proofs following the pattern in repos like `typed-wasm`, `proven`, `echidna`, or `boj-server`. diff --git a/REQUIRES_INITIALISATION.md b/REQUIRES_INITIALISATION.md new file mode 100644 index 0000000..776cb2f --- /dev/null +++ b/REQUIRES_INITIALISATION.md @@ -0,0 +1,118 @@ + + +# REQUIRES INITIALISATION + +**This repository is not finished being set up.** 9 substitution token(s) across 3 file(s) still have no value. + +## Why this is not already done + +This repo was created from `hyperpolymath/rsr-template-repo`. The mint +(`just repo-init`) fills every token that has a single mechanical answer — +owner, repo, author, dates, licence, branch — and it has done so here. + +The tokens below are the ones it *deliberately cannot* answer. They need a +decision or a fact that exists only in your head: what this project is for, +what command builds it, which port the service listens on, whether a PGP key +is held at all. The template's own token vocabulary says as much — you cannot +sensibly answer "required invariants" in a thirty-second bootstrap. + +They were left **visibly unfilled on purpose**. The alternatives were both +worse: inventing plausible values would put confident falsehoods into a +security policy and an architecture document, and silently deleting the +sections would hide the fact that a decision is owed. A visible gap is +honest; a fabricated answer is not. + +## Do not delete this file until every item below is resolved + +This file is the only marker that the work is outstanding. Deleting it early +does not finish the setup, it just conceals it — and the next person or agent +to arrive will reasonably assume the repo is complete. + +- **If you are a person:** delete this file yourself once the last item is done. +- **If you are an agent:** resolve what you legitimately can, leave the rest, + and delete this file only when no token below remains anywhere in the tree. + Do not delete it to make a gate go green. + +Re-running the estate top-up tool will remove this file automatically once +nothing is outstanding, so the safest way to finish is to fix the tokens and +let the check confirm it. + +## What is needed, and where it goes + +### `{{CONSUMER1}}` + +A downstream repo that consumes this one. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{CONSUMER2}}` + +A second downstream consumer. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{DEP1}}` + +First named dependency, in .machine_readable/INTENT.contractile. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{DEP2}}` + +Second named dependency, in .machine_readable/INTENT.contractile. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{MONOREPO_OR_STANDALONE}}` + +Literally 'monorepo' or 'standalone'. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{ONE_PARAGRAPH_ANTI_PURPOSE}}` + +A paragraph on what this deliberately is NOT for. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{ONE_PARAGRAPH_PURPOSE}}` + +A paragraph on what this is for. + +Appears in: + +- `.machine_readable/INTENT.contractile` + +### `{{PROJECT_UNIQUE_STRENGTH}}` + +What this does that its alternatives do not. + +Appears in: + +- `.machine_readable/agent_instructions/methodology.a2ml` + +### `{{VERSION}}` + +Version/tag for the container image. + +Appears in: + +- `bgp-backbone-lab/Justfile` + +--- + +Generated by the estate top-up pass. Rationale and the governing rulings are +in `hyperpolymath/standards`; the token vocabulary is +`.machine_readable/ai/PLACEHOLDERS.adoc` in `rsr-template-repo`. diff --git a/bgp-backbone-lab/ABI-FFI-README.md b/bgp-backbone-lab/ABI-FFI-README.md index f06f72c..8d81dd2 100644 --- a/bgp-backbone-lab/ABI-FFI-README.md +++ b/bgp-backbone-lab/ABI-FFI-README.md @@ -1,6 +1,6 @@ {{~ Aditionally delete this line and fill out the template below ~}} -# {{PROJECT}} ABI/FFI Documentation +# AERIE ABI/FFI Documentation ## Overview @@ -247,7 +247,7 @@ gcc -o example example.c -l{{project}} -L./zig-out/lib ### From Idris2 ```idris -import {{PROJECT}}.ABI.Foreign +import AERIE.ABI.Foreign main : IO () main = do diff --git a/bgp-backbone-lab/ffi/zig/build.zig b/bgp-backbone-lab/ffi/zig/build.zig index 4a2e049..4178db7 100644 --- a/bgp-backbone-lab/ffi/zig/build.zig +++ b/bgp-backbone-lab/ffi/zig/build.zig @@ -1,4 +1,4 @@ -// {{PROJECT}} FFI Build Configuration +// AERIE FFI Build Configuration // SPDX-License-Identifier: MPL-2.0 const std = @import("std"); diff --git a/bgp-backbone-lab/ffi/zig/src/main.zig b/bgp-backbone-lab/ffi/zig/src/main.zig index 6b233bc..5d7f10b 100644 --- a/bgp-backbone-lab/ffi/zig/src/main.zig +++ b/bgp-backbone-lab/ffi/zig/src/main.zig @@ -1,4 +1,4 @@ -// {{PROJECT}} FFI Implementation +// AERIE FFI Implementation // // This module implements the C-compatible FFI declared in src/abi/Foreign.idr // All types and layouts must match the Idris2 ABI definitions. @@ -9,7 +9,7 @@ const std = @import("std"); // Version information (keep in sync with project) const VERSION = "0.1.0"; -const BUILD_INFO = "{{PROJECT}} built with Zig " ++ @import("builtin").zig_version_string; +const BUILD_INFO = "AERIE built with Zig " ++ @import("builtin").zig_version_string; /// Thread-local error storage threadlocal var last_error: ?[]const u8 = null; diff --git a/bgp-backbone-lab/ffi/zig/test/integration_test.zig b/bgp-backbone-lab/ffi/zig/test/integration_test.zig index 0341994..48d0f90 100644 --- a/bgp-backbone-lab/ffi/zig/test/integration_test.zig +++ b/bgp-backbone-lab/ffi/zig/test/integration_test.zig @@ -1,4 +1,4 @@ -// {{PROJECT}} Integration Tests +// AERIE Integration Tests // SPDX-License-Identifier: MPL-2.0 // // These tests verify that the Zig FFI correctly implements the Idris2 ABI