-
-
Notifications
You must be signed in to change notification settings - Fork 0
chore: fill derivable placeholders, drop false ARCHITECTURE, surface the rest #223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| <!-- SPDX-License-Identifier: CC-BY-SA-4.0 --> | ||
|
|
||
| # REQUIRES INITIALISATION | ||
|
|
||
| **This repository is not finished being set up.** 4 substitution token(s) across 4 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 | ||
|
|
||
| ### `{{ARGS}}` | ||
|
|
||
| Arguments for the justfile recipe this appears in. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `.machine_readable/contractiles/Justfile` | ||
| - `Justfile` | ||
|
|
||
| ### `{{CONDUCT_TEAM}}` | ||
|
|
||
| Name of the conduct body. If there is no committee, rewrite the sentence rather than substituting a plural noun into 'a {{CONDUCT_TEAM}} member'. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `CODE_OF_CONDUCT.md` | ||
|
|
||
| ### `{{COQC}}` | ||
|
|
||
| Appears in: | ||
|
|
||
| - `formal/Justfile` | ||
|
|
||
| ### `{{RESPONSE_TIME}}` | ||
|
|
||
| Initial-response SLA for a security or conduct report. Promise only what a solo maintainer can actually meet. | ||
|
|
||
| Appears in: | ||
|
|
||
| - `CODE_OF_CONDUCT.md` | ||
|
|
||
| --- | ||
|
|
||
| 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`. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| {{~ Aditionally delete this line and fill out the template below ~}} | ||
|
|
||
| # {{PROJECT}} ABI/FFI Documentation | ||
| # VERISIMDB ABI/FFI Documentation | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💡 Quality: PROJECT substituted as all-caps VERISIMDB in Idris module path
Was this helpful? React with 👍 / 👎 |
||
|
|
||
| ## Overview | ||
|
|
||
|
|
@@ -247,7 +247,7 @@ gcc -o example example.c -l{{project}} -L./zig-out/lib | |
| ### From Idris2 | ||
|
|
||
| ```idris | ||
| import {{PROJECT}}.ABI.Foreign | ||
| import VERISIMDB.ABI.Foreign | ||
|
|
||
| main : IO () | ||
| main = do | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
REQUIRES_INITIALISATION.md lists
{{ARGS}}and{{COQC}}as outstanding substitution tokens, and 0-AI-MANIFEST.a2ml's PRIORITY ACTION directs a person or agent to resolve them. But these are legitimatejustinterpolations, not RSR placeholders:{{ARGS}}interpolates the variadic recipe parameter*ARGS(Justfile:58-59), and{{COQC}}interpolates the variableCOQC := "coqc"(formal/Justfile:12). An agent that tries to 'fill' them would break the recipes. The same conflation caused{{OWNER}}— a reference to the top-levelOWNER := "hyperpolymath"variable — to be hardcoded inside the container-init recipe body (Justfile:389-390 and the mirrored contractiles Justfile), losing the single-source-of-truth link to the variable. Excludejustvariable/parameter interpolations from the placeholder scan so they are neither listed as work nor rewritten to literals.Was this helpful? React with 👍 / 👎