|
5 | 5 | :toc: |
6 | 6 | :toc-placement: preamble |
7 | 7 |
|
8 | | -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://{{FORGE}}/{{OWNER}}/{{REPO}}"] |
9 | | -image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"] |
10 | | -image:https://raw.githubusercontent.com/hyperpolymath/palimpsest-license/main/assets/badges/svg/badge-quantum-safe.svg[Quantum-Safe Provenance,link="https://github.com/hyperpolymath/palimpsest-license/blob/main/v1.0/exhibits/EXHIBIT-B-QUANTUM-SAFE.txt"] |
11 | | -image:https://img.shields.io/badge/Docs-CC--BY--SA--4.0-blue.svg[Docs: CC-BY-SA-4.0,link="https://creativecommons.org/licenses/by-sa/4.0/"] |
12 | | -image:https://api.thegreenwebfoundation.org/greencheckimage/{{FORGE}}[Green Web,link="https://www.thegreenwebfoundation.org/green-web-check/?url={{FORGE}}"] |
| 8 | += this-ssg |
| 9 | +:sectnums: |
| 10 | +:toc: macro |
13 | 11 |
|
14 | | -{{PROJECT_DESCRIPTION}} |
| 12 | +[quote, Axiom.jl] |
| 13 | +____ |
| 14 | +"Trust, but verify. Actually, just verify." |
| 15 | +____ |
15 | 16 |
|
16 | | -[IMPORTANT] |
17 | | -==== |
18 | | -*This file is a template.* You are reading `README.adoc` from the *RSR template repo* |
19 | | -(or a freshly-cloned copy of it). Run `just init` to replace every `{{PLACEHOLDER}}` |
20 | | -token with your project's details, then delete this admonition. Until you do, the |
21 | | -`{{...}}` markers below are intentional placeholders, not content. |
22 | | -==== |
| 17 | +`this-ssg` is a next-generation static site generation layer built for the `hyperpolymath` estate. It enforces compile-time layout verification, type-safe token routing, and absolute local scope for data structures generated by *My-Lang*. |
23 | 18 |
|
24 | | -== What this is |
| 19 | +Rejecting the messy runtime abstractions, dynamic graph leaks, and fragile cascading themes of traditional engines, `this-ssg` handles structural components through the lens of *trope-particularity*. Every file is processed as an unrepeatable, isolated property instance (*haecceity*), guaranteeing mathematical deterministic output before code deployment. |
25 | 20 |
|
26 | | -A new repository scaffolded from the *Rhodium Standard Repository (RSR)* template: |
27 | | -a batteries-included starting point that ships with CI/CD, machine-readable project |
28 | | -metadata, an AI-agent gatekeeper protocol, a formally-typed ABI/FFI seam |
29 | | -(Idris2 + Zig), container and reproducible-build scaffolding, and governance |
30 | | -infrastructure — all wired and passing the RSR validators on day one. |
| 21 | +toc::[] |
31 | 22 |
|
32 | | -Replace this section with a description of *your* project once initialised. |
| 23 | +== Core Features |
33 | 24 |
|
34 | | -== Quick start |
| 25 | +* *Absolute Local Isolation:* Eliminates global configuration leakage. Layout components exist as non-independent moments (*Momente*), strictly bound to their immediate file scope. |
| 26 | +* *Formal Token Discharging:* Fully integrated with type-checked pipelines (`ddraig`/`casket`). Misaligned metadata keys or missing layout tokens trigger immediate compilation gates rather than silent production failures. |
| 27 | +* *Pure Passthrough Preservation:* Enforces strict compliance for system paths (e.g., `.well-known/security.txt`). Content blocks flag bypass constraints explicitly, preventing parsing noise or unintended HTML wrapping. |
| 28 | +* *RSR Compliant Blueprint:* Native structure matching the `rsr-template-repo` configuration matrix. |
35 | 29 |
|
36 | | -[source,bash] |
| 30 | +== Quick Start |
| 31 | + |
| 32 | +=== Workspace Blueprint |
| 33 | +Ensure your repository implements the verified asset structure: |
| 34 | + |
| 35 | +[source, text] |
| 36 | +---- |
| 37 | +├── assets/ |
| 38 | +│ └── .well-known/ |
| 39 | +│ └── security.txt |
| 40 | +├── templates/ |
| 41 | +│ └── default.html |
| 42 | +└── x-ssg.config.json |
| 43 | +---- |
| 44 | + |
| 45 | +=== Direct Compilation |
| 46 | +Invoke the compilation matrix locally via your CLI toolchain: |
| 47 | + |
| 48 | +[source, bash] |
| 49 | +---- |
| 50 | +this-ssg build --source src/pages --output dist/ |
37 | 51 | ---- |
38 | | -# 1. Create a repo from this template (or clone it), then from the repo root: |
39 | | -just init # interactive bootstrap: fills every {{PLACEHOLDER}} |
40 | 52 |
|
41 | | -# 2. See the available tasks: |
42 | | -just # lists all phases (build, test, validate, audit, ...) |
| 53 | +Alternatively, discharge your standard validation pipeline via `contractile.just`: |
43 | 54 |
|
44 | | -# 3. Check the repo still satisfies the RSR shape: |
45 | | -just validate # structure + metadata checks |
| 55 | +[source, bash] |
| 56 | +---- |
| 57 | +just build-this |
46 | 58 | ---- |
47 | 59 |
|
48 | | -`just init` prompts for the project name, owner, author, licence contact, and the |
49 | | -other values listed in `.machine_readable/ai/PLACEHOLDERS.adoc`, substitutes them |
50 | | -across the tree, validates the result, and (if available) runs the `k9-svc` checks. |
51 | | - |
52 | | -== What you get |
53 | | - |
54 | | -* *Machine-readable metadata* (`.machine_readable/6a2/`) — `STATE`, `META`, |
55 | | - `ECOSYSTEM`, `PLAYBOOK`, `AGENTIC`, `NEUROSYM`, `CLADE`, and `anchors/ANCHOR`, |
56 | | - in a2ml, so tools and agents can read the project's state and boundaries. |
57 | | -* *AI gatekeeper protocol* — `0-AI-MANIFEST.a2ml` is the universal entry point that |
58 | | - tells an AI agent how to work in this repo before it touches anything. |
59 | | -* *Typed ABI/FFI seam* — `src/interface/Abi/` (Idris2 type + layout proofs) over |
60 | | - `src/interface/ffi/` (Zig implementation), with generated C headers. |
61 | | -* *CI/CD* — GitHub Actions for quality, security (CodeQL, Scorecard, secret |
62 | | - scanning), multi-forge mirroring, and RSR anti-pattern enforcement. |
63 | | -* *Supply-chain & reproducibility* — container layering (stapeln), Guix shells, |
64 | | - SBOM, and signing hooks. |
65 | | -* *Governance* — `GOVERNANCE.adoc`, `MAINTAINERS.adoc`, `.github/` community health |
66 | | - files, and a release `AUDIT.adoc` gate. |
67 | | - |
68 | | -== Repository map |
69 | | - |
70 | | -[cols="1,3"] |
71 | | -|=== |
72 | | -| Path | What lives there |
73 | | - |
74 | | -| `0-AI-MANIFEST.a2ml` | Universal entry point for AI agents (read first). |
75 | | -| `.machine_readable/` | Project metadata, policies, contractiles, AI configs. |
76 | | -| `src/interface/` | Typed ABI (Idris2) + FFI (Zig) + generated headers. |
77 | | -| `docs/` | Onboarding, status, governance, practice, decisions. |
78 | | -| `build/`, `Justfile` | Task orchestration (`just` phases delegate to `build/just/*.just`). |
79 | | -| `.github/` | Workflows + community health files. |
80 | | -| `tests/`, `benches/` | Test suites and benchmarks. |
81 | | -|=== |
82 | | - |
83 | | -== Where to go next |
84 | | - |
85 | | -* `EXPLAINME.adoc` — the engineering deep-dive: how the pieces actually work. |
86 | | -* `AFFIRMATION.adoc` — the dated, signed honesty snapshot of the repo's true state. |
87 | | -* `AUDIT.adoc` — the release audit gate. |
88 | | -* `.machine_readable/ai/PLACEHOLDERS.adoc` — the full placeholder reference. |
| 60 | +== Status & Tracking |
| 61 | + |
| 62 | +* Conforms to `.machine_readable/6a2/META.a2ml` protocol gates. |
| 63 | +* Track project goals, verification checks, and automated proof matrices directly in `EXPLAINME.adoc`. |
| 64 | + |
89 | 65 |
|
90 | 66 | == Licence |
91 | 67 |
|
|
0 commit comments