diff --git a/0-AI-MANIFEST.a2ml b/0-AI-MANIFEST.a2ml index 197eb0db..bc4f566f 100644 --- a/0-AI-MANIFEST.a2ml +++ b/0-AI-MANIFEST.a2ml @@ -13,3 +13,20 @@ ## Delivery Promises - Mention in summaries whether STATE, `contractiles/`, or `.bot_directives/` changed. - Keep this file in sync with the repository’s status; update it if the governance changes. + + + +## PRIORITY ACTION — this repository is not fully initialised + +5 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/ABI-FFI-README.md b/ABI-FFI-README.md index ada05ffd..e4ee8afb 100644 --- a/ABI-FFI-README.md +++ b/ABI-FFI-README.md @@ -4,7 +4,7 @@ Copyright (c) Jonathan D.A. Jewell --> {{~ Aditionally delete this line and fill out the template below ~}} -# {{PROJECT}} ABI/FFI Documentation +# ACADEMIC_WORKFLOW_SUITE ABI/FFI Documentation ## Overview @@ -251,7 +251,7 @@ gcc -o example example.c -l{{project}} -L./zig-out/lib ### From Idris2 ```idris -import {{PROJECT}}.ABI.Foreign +import ACADEMIC_WORKFLOW_SUITE.ABI.Foreign main : IO () main = do diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md deleted file mode 100644 index 607e3d8c..00000000 --- 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 100606c9..c42ec7af 100644 --- a/PROOF-NEEDS.md +++ b/PROOF-NEEDS.md @@ -29,4 +29,4 @@ Copyright (c) Jonathan D.A. Jewell 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 ACADEMIC_WORKFLOW_SUITE/Jonathan D.A. Jewell placeholders and no domain-specific proofs. diff --git a/REQUIRES_INITIALISATION.md b/REQUIRES_INITIALISATION.md new file mode 100644 index 00000000..8411fe91 --- /dev/null +++ b/REQUIRES_INITIALISATION.md @@ -0,0 +1,87 @@ + + +# REQUIRES INITIALISATION + +**This repository is not finished being set up.** 5 substitution token(s) across 9 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 + +### `{{BACKUP_FILE}}` + +Appears in: + +- `tasks/Justfile` + +### `{{PROJECT_UNIQUE_STRENGTH}}` + +What this does that its alternatives do not. + +Appears in: + +- `.machine_readable/bot_directives/methodology.a2ml` + +### `{{RECIPE}}` + +Appears in: + +- `tasks/Justfile` + +### `{{SHA256}}` + +Appears in: + +- `release/flatpak/com.academicworkflow.AWS.yaml` + +### `{{VERSION}}` + +Version/tag for the container image. + +Appears in: + +- `release/appimage/AppImageBuilder.yml` +- `release/flatpak/com.academicworkflow.AWS.yaml` +- `release/packaging/debian/changelog` +- `release/packaging/debian/control` +- `release/scripts/package.sh` +- `release/scripts/release.sh` +- `release/snap/snapcraft.yaml` +- `tasks/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/ffi/zig/build.zig b/ffi/zig/build.zig index c02617fc..a699c6a3 100644 --- a/ffi/zig/build.zig +++ b/ffi/zig/build.zig @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MPL-2.0 // Copyright (c) Jonathan D.A. Jewell -// {{PROJECT}} FFI Build Configuration +// ACADEMIC_WORKFLOW_SUITE FFI Build Configuration const std = @import("std"); diff --git a/ffi/zig/test/integration_test.zig b/ffi/zig/test/integration_test.zig index e4815085..46c2fbc1 100644 --- a/ffi/zig/test/integration_test.zig +++ b/ffi/zig/test/integration_test.zig @@ -1,6 +1,6 @@ // SPDX-License-Identifier: MPL-2.0 // Copyright (c) Jonathan D.A. Jewell -// {{PROJECT}} Integration Tests +// ACADEMIC_WORKFLOW_SUITE Integration Tests // // These tests verify that the Zig FFI correctly implements the Idris2 ABI diff --git a/release/packaging/debian/changelog b/release/packaging/debian/changelog index 53afe84c..a2fb9ba9 100644 --- a/release/packaging/debian/changelog +++ b/release/packaging/debian/changelog @@ -2,4 +2,4 @@ academic-workflow-suite ({{VERSION}}) stable; urgency=medium * See CHANGELOG.md for detailed changes - -- Academic Workflow Suite Team {{DATE}} + -- Academic Workflow Suite Team 2026-08-05 diff --git a/release/scripts/release.sh b/release/scripts/release.sh index c003f672..82fbc530 100755 --- a/release/scripts/release.sh +++ b/release/scripts/release.sh @@ -274,7 +274,7 @@ generate_release_notes() { local output="$RELEASE_DIR/release-notes-$version.md" if [ -f "$template" ]; then - sed "s/{{VERSION}}/$version/g; s/{{DATE}}/$(date +%Y-%m-%d)/g" "$template" > "$output" + sed "s/{{VERSION}}/$version/g; s/2026-08-05/$(date +%Y-%m-%d)/g" "$template" > "$output" # Append changelog section echo "" >> "$output"