Skip to content

Commit c59c19c

Browse files
hyperpolymathclaude
andcommitted
fix(docs): correct README header + crash-mode counts + dangling refs
Adversarial verification of the tidy caught defects in files this branch already touched: README.adoc — the Tier-B "authoring standard" edit left a botched, duplicated document header: a second :toc:/:source-highlighter: attribute block sitting AFTER body content (so it was inert and rendered as stray text), a stray mid-body author line, and an orphan bare DOI URL citing the WRONG Zenodo record (19680824 vs the canonical 19520245 used by the badge, the Citation block, and CITATION.cff). Collapse to a single clean header: attributes before any body, all badges grouped, one correct DOI. Factual fixes (verified against zig/src/safe_nif.zig, which has 8 exports of which FIVE are crash_*): "six crash modes" -> "five" in README repo-layout and QUICKSTART-DEV project-structure. Make the benchmark command's working directory explicit (run from demo/). Drop the dangling `.claude/CLAUDE.md` reference in QUICKSTART-DEV (no such file in this repo) and the inaccurate "signing-key policy" pointer (CONTRIBUTING.md documents the contribution flow, not keys). NOT touched: the residual PMPL-1.0 license badge in README is left verbatim for manual owner review (licence markup is owner-only; flagged, not auto-edited). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 6841c75 commit c59c19c

2 files changed

Lines changed: 7 additions & 12 deletions

File tree

QUICKSTART-DEV.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ just proof-status # summary of proven / tested / trusted
5959
[source]
6060
----
6161
snifs/
62-
├── zig/src/safe_nif.zig # the SNIF kernel — six trapped crash modes
62+
├── zig/src/safe_nif.zig # the SNIF kernel — five trapped crash modes
6363
├── zig/ # safe_nif / buffer_abi / burble_fft guests
6464
├── rust/ , rust-guest/ # Rust→wasm32 guests (dual-sourced; see Dustfile)
6565
├── demo/ # Mix project: wasmex loader + ExUnit suite
@@ -94,11 +94,11 @@ just proof-check-all # all proofs still check
9494
just assail # no new security findings
9595
----
9696

97-
Commits must be **signed**. See `CONTRIBUTING.md` for the signing-key policy.
97+
Commits must be *signed*. See `CONTRIBUTING.md` for the contribution flow.
9898

9999
== LLM / AI Agent Development
100100

101-
Read `0-AI-MANIFEST.a2ml` and `.claude/CLAUDE.md` first, then `PROOF-STATUS.md`
101+
Read `0-AI-MANIFEST.a2ml` first, then `PROOF-STATUS.md`
102102
before making any claim about what is proven.
103103

104104
== Get Help

README.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,18 @@
55
= SNIFs: Safer Native Implemented Functions for the BEAM via WebAssembly Sandboxing
66
:toc: preamble
77
:icons: font
8+
:source-highlighter: highlight.js
89

910
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://github.com/hyperpolymath/snifs"]
1011
image:https://img.shields.io/badge/License-MPL_2.0-blue.svg[License: MPL-2.0,link="https://opensource.org/licenses/MPL-2.0"]
1112
image:https://api.thegreenwebfoundation.org/greencheckimage/github.com[Green Web,link="https://www.thegreenwebfoundation.org/green-web-check/?url=github.com"]
12-
13-
https://doi.org/10.5281/zenodo.19680824
13+
image:https://zenodo.org/badge/DOI/10.5281/zenodo.19520245.svg[DOI,link=https://doi.org/10.5281/zenodo.19520245]
1414

1515
This repository contains:
1616
(1) the SNIF architecture paper,
1717
(2) a working BEAM + WASM implementation,
1818
(3) integration tests and benchmarking,
1919
(4) formal verification artifacts.
20-
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
21-
:toc:
22-
:source-highlighter: highlight.js
23-
24-
image:https://zenodo.org/badge/DOI/10.5281/zenodo.19520245.svg[DOI,link=https://doi.org/10.5281/zenodo.19520245]
2520
image:https://img.shields.io/badge/license-PMPL--1.0--or--later-blue[License]
2621

2722
== Overview
@@ -84,7 +79,7 @@ workload:
8479
| *Marshalling* | ∝ bytes: copying buffers into/out of linear memory. Dominates *data-heavy* calls; mitigated by keeping buffers resident across calls.
8580
|===
8681

87-
Measured in-BEAM (OTP 25, `fibonacci(20)`, n=2000; `mix run bench/snif_bench.exs`):
82+
Measured in-BEAM (OTP 25, `fibonacci(20)`, n=2000; from `demo/`, `mix run bench/snif_bench.exs`):
8883

8984
----
9085
case mean_µs p50_µs p99_µs
@@ -150,7 +145,7 @@ verified — see paper).
150145
== Repository layout
151146

152147
----
153-
zig/src/safe_nif.zig Zig source with six crash modes + fibonacci
148+
zig/src/safe_nif.zig Zig source with five crash modes + fibonacci
154149
priv/*.wasm Pre-built WASM binaries (ReleaseSafe + ReleaseFast)
155150
demo/ Mix project with wasmex loader + ExUnit test suite
156151
docs/whitepapers/ LaTeX paper + compiled PDF

0 commit comments

Comments
 (0)