|
1 | 1 | // SPDX-License-Identifier: CC-BY-SA-4.0 |
2 | 2 | // SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath) <6759885+hyperpolymath@users.noreply.github.com> |
3 | 3 | = Architecture — technical-notes |
4 | | -:revdate: 2026-MM-DD |
| 4 | +:revdate: 2026-07-27 |
5 | 5 |
|
6 | 6 | == System overview |
7 | 7 |
|
8 | | -One paragraph: what this project does and what it does not do. State the |
9 | | -*invariant* — the property that, if violated, would make the whole project |
10 | | -pointless. Future maintainers will read this paragraph first. |
| 8 | +`technical-notes` is a documentation archive, not a running system. It |
| 9 | +holds short, citable technical notes (Markdown, optionally with a Typst |
| 10 | +source and rendered PDF) that are individually deposited on Zenodo with a |
| 11 | +DOI. The invariant that matters: every note listed in the README resolves |
| 12 | +to a real, citable Zenodo record. If that link breaks, the repo has |
| 13 | +failed at its one job. |
11 | 14 |
|
12 | 15 | == Component diagram |
13 | 16 |
|
14 | | -Replace this section with an ASCII or Mermaid diagram. Keep it under 20 |
15 | | -lines — anything bigger belongs in `architecture/`. |
| 17 | +There is no runtime component graph. The only "flow" is authorial: |
16 | 18 |
|
17 | 19 | [source] |
18 | 20 | ---- |
19 | | -+------------------+ +------------------+ |
20 | | -| Component A | ---> | Component B | |
21 | | -+------------------+ +------------------+ |
22 | | - | |
23 | | - v |
24 | | -+------------------+ |
25 | | -| Component C | |
26 | | -+------------------+ |
| 21 | +draft note (.md [+ .typ -> .pdf]) |
| 22 | + | |
| 23 | + v |
| 24 | + README table entry (title, date, concept DOI, version DOI) |
| 25 | + | |
| 26 | + v |
| 27 | + Zenodo deposit (direct API today; GitHub Release once the |
| 28 | + Zenodo-GitHub integration is enabled) |
27 | 29 | ---- |
28 | 30 |
|
29 | 31 | == Data flow |
30 | 32 |
|
31 | | -For each external input, describe: |
32 | | - |
33 | | -* **Source**: where it comes from. |
34 | | -* **Validation**: what guarantees we enforce on entry. |
35 | | -* **Transformation**: high-level processing stages. |
36 | | -* **Sink**: where the result goes. |
| 33 | +* **Source**: the maintainer's own drafting — no external input feed. |
| 34 | +* **Validation**: none automated beyond estate governance CI (SPDX |
| 35 | + headers, licence consistency, secrets scanning — see |
| 36 | + `.github/workflows/governance.yml` and |
| 37 | + `.github/workflows/hypatia-scan.yml`). |
| 38 | +* **Transformation**: optional Typst → PDF render for notes that ship one. |
| 39 | +* **Sink**: Zenodo (DOI-bearing deposit) and the README index. |
37 | 40 |
|
38 | 41 | == Key invariants |
39 | 42 |
|
40 | | -Enumerate the load-bearing invariants of the system. Each should have: |
41 | | - |
42 | | -. A one-line statement. |
43 | | -. The code location(s) that enforce it. |
44 | | -. The failure mode if the invariant is violated. |
45 | | - |
46 | | -Example: |
47 | | - |
48 | 43 | [cols="1,2,2,2", options="header"] |
49 | 44 | |=== |
50 | 45 | | # | Invariant | Enforced at | Failure mode |
51 | 46 |
|
52 | 47 | | 1 |
53 | | -| All HTTP requests carry a valid `X-Request-ID`. |
54 | | -| `src/middleware/request_id.rs` |
55 | | -| Logs become unjoinable; correlation breaks. |
| 48 | +| Every README row has a resolvable DOI link. |
| 49 | +| Manual, at note-publish time. |
| 50 | +| Citation breaks; the note becomes unfindable via its concept DOI. |
56 | 51 |
|
57 | 52 | | 2 |
58 | | -| The output buffer is always flushed before exit. |
59 | | -| `src/main.rs:88-92` (Drop impl) |
60 | | -| Last ~16KB of log lost on crash. |
| 53 | +| Every published note's licence matches its Zenodo deposit metadata. |
| 54 | +| `.zenodo.json` for the deposited record; manual cross-check. |
| 55 | +| Licence mismatch between GitHub and the archival copy. |
61 | 56 | |=== |
62 | 57 |
|
63 | 58 | == Dependencies |
64 | 59 |
|
65 | | -* **Internal**: list other hyperpolymath repos this depends on. |
66 | | -* **External**: SHA-pinned (see `Cargo.lock` / `deno.lock` / etc.). |
67 | | -* **Build-time**: tools required to build (just, deno, cargo, …). |
| 60 | +* **Internal**: none — this repo does not depend on other hyperpolymath |
| 61 | + repos. |
| 62 | +* **External**: Zenodo (archival + DOI minting). |
| 63 | +* **Build-time**: none to read a note; Typst only when producing a PDF |
| 64 | + rendering of a note that has one. |
68 | 65 |
|
69 | 66 | == Out of scope |
70 | 67 |
|
71 | | -Explicit non-goals. Things we deliberately do *not* do, with a one-line |
72 | | -reason for each. This section saves more time than the rest combined. |
| 68 | +* No source code, package, or binary is built or shipped from this repo. |
| 69 | +* No API, service, or CLI — there is nothing to run. |
| 70 | +* No automated test suite — there is no code to exercise. |
73 | 71 |
|
74 | 72 | == See also |
75 | 73 |
|
76 | | -* link:./usage.adoc[Usage] — consumer perspective. |
77 | | -* link:./contributing.adoc[Contributing] — developer setup. |
| 74 | +* link:./usage.adoc[Usage] — how to cite a note. |
| 75 | +* link:./contributing.adoc[Contributing] — how to add a new note. |
78 | 76 | * link:./decisions/[ADRs] — historical record of why this shape. |
0 commit comments