Skip to content
Closed
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
15 changes: 4 additions & 11 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# CODEOWNERS - Defines code ownership for review requirements
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

# Default owners for everything in the repo
* @hyperpolymath

# Workflow files require maintainer review (security-critical)
/.github/workflows/ @hyperpolymath

# Security policy requires maintainer review
/SECURITY.md @hyperpolymath
# SPDX-License-Identifier: MPL-2.0
# 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.
17 changes: 17 additions & 0 deletions 0-AI-MANIFEST.a2ml
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,20 @@ After reading this file, demonstrate understanding by stating:
- **Maintained By:** [YOUR-NAME/ORG]
- **License:** MPL-2.0
- **Protocol:** https://github.com/hyperpolymath/0-ai-gatekeeper-protocol

<!-- BEGIN requires-initialisation -->

## PRIORITY ACTION — this repository is not fully initialised

12 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.

<!-- END requires-initialisation -->
47 changes: 0 additions & 47 deletions ARCHITECTURE.md

This file was deleted.

2 changes: 1 addition & 1 deletion PROOF-NEEDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,4 +78,4 @@ currently unused, so this is cheap to fix now and expensive to discover later.

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 MAA_FRAMEWORK/Jonathan D.A. Jewell placeholders and no domain-specific proofs.
16 changes: 8 additions & 8 deletions QUICKSTART-MAINTAINER.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: CC-BY-SA-4.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// Template: QUICKSTART-MAINTAINER.adoc — packaging, deploying, and maintaining
// Replace maa-framework, {{PACKAGE_NAME}}, {{DEPS}} with actuals
// Replace maa-framework, maa-framework, {{DEPS}} with actuals
= maa-framework — Quick Start for Platform Maintainers
:toc:
:toclevels: 2
Expand Down Expand Up @@ -66,10 +66,10 @@ Files installed:
| `$PREFIX/bin/`
| Executables

| `$PREFIX/share/{{PACKAGE_NAME}}/`
| `$PREFIX/share/maa-framework/`
| Data files, assets

| `$PREFIX/share/doc/{{PACKAGE_NAME}}/`
| `$PREFIX/share/doc/maa-framework/`
| Documentation

| `$PREFIX/share/applications/`
Expand All @@ -81,9 +81,9 @@ Files installed:

== Configuration

Default config location: `$XDG_CONFIG_HOME/{{PACKAGE_NAME}}/config.toml`
Default config location: `$XDG_CONFIG_HOME/maa-framework/config.toml`

Fallback: `$HOME/.config/{{PACKAGE_NAME}}/config.toml`
Fallback: `$HOME/.config/maa-framework/config.toml`

== Health Checks

Expand All @@ -103,7 +103,7 @@ just build-release
just install --prefix=/usr/local
----

Or via OPSM: `opsm update {{PACKAGE_NAME}}`
Or via OPSM: `opsm update maa-framework`

== Security Notes

Expand All @@ -118,8 +118,8 @@ For deploying multiple instances (e.g., different users or tenants):

[source,bash]
----
just install --prefix=/opt/{{PACKAGE_NAME}}-instance1 --config=/etc/{{PACKAGE_NAME}}/instance1.toml
just install --prefix=/opt/{{PACKAGE_NAME}}-instance2 --config=/etc/{{PACKAGE_NAME}}/instance2.toml
just install --prefix=/opt/maa-framework-instance1 --config=/etc/maa-framework/instance1.toml
just install --prefix=/opt/maa-framework-instance2 --config=/etc/maa-framework/instance2.toml
----

Each instance has isolated config, data, and logs.
Expand Down
134 changes: 134 additions & 0 deletions REQUIRES_INITIALISATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->

# REQUIRES INITIALISATION

**This repository is not finished being set up.** 12 substitution token(s) across 5 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

### `{{BUILD_CMD}}`

The exact command that builds this project.

Appears in:

- `QUICKSTART-DEV.adoc`

### `{{BUILD_OUTPUT_PATH}}`

Where the build artefact lands.

Appears in:

- `QUICKSTART-MAINTAINER.adoc`

### `{{CI_COMMIT_REF_SLUG}}`

Appears in:

- `aletheia/extraction/rhodium-pipeline/src/lib.rs`

### `{{CI_PROJECT_DIR}}`

Appears in:

- `aletheia/extraction/rhodium-pipeline/src/lib.rs`

### `{{DEPS}}`

Prose summary of runtime/build dependencies.

Appears in:

- `QUICKSTART-MAINTAINER.adoc`

### `{{LANG_STACK}}`

The language stack, in prose.

Appears in:

- `QUICKSTART-DEV.adoc`

### `{{MUST_INVARIANTS}}`

The invariants this project guarantees. Not answerable in a bootstrap; it is the point of the repo.

Appears in:

- `QUICKSTART-DEV.adoc`

### `{{PATH}}`

Appears in:

- `aletheia/Justfile`

### `{{PROJECT_UNIQUE_STRENGTH}}`

What this does that its alternatives do not.

Appears in:

- `.machine_readable/bot_directives/methodology.a2ml`

### `{{TEST_CMD}}`

The exact command that runs its tests.

Appears in:

- `QUICKSTART-DEV.adoc`

### `{{VERSION}}`

Version/tag for the container image.

Appears in:

- `aletheia/Justfile`

### `{{WORKSPACE}}`

Appears in:

- `aletheia/extraction/rhodium-pipeline/src/lib.rs`

---

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`.
2 changes: 1 addition & 1 deletion aletheia/ffi/zig/build.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} FFI Build Configuration
// MAA_FRAMEWORK FFI Build Configuration

const std = @import("std");

Expand Down
4 changes: 2 additions & 2 deletions aletheia/ffi/zig/src/main.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} FFI Implementation
// MAA_FRAMEWORK 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.
Expand All @@ -10,7 +10,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 = "MAA_FRAMEWORK built with Zig " ++ @import("builtin").zig_version_string;

/// Thread-local error storage
threadlocal var last_error: ?[]const u8 = null;
Expand Down
2 changes: 1 addition & 1 deletion aletheia/ffi/zig/test/integration_test.zig
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
// {{PROJECT}} Integration Tests
// MAA_FRAMEWORK Integration Tests
//
// These tests verify that the Zig FFI correctly implements the Idris2 ABI

Expand Down