1- <!--
2- SPDX-License-Identifier: CC-BY-SA-4.0
3- SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
4- -->
1+ == Architecture
52
6- # Architecture
7-
8- ` technical-notes ` is a documentation archive, not a software project:
3+ `+technical-notes+` is a documentation archive, not a software project:
94it holds short, citable technical notes (Markdown, optionally with a
10- Typst source and rendered PDF) that are individually deposited on
11- Zenodo with a DOI. There is no source code, no build system, and no
12- runtime component.
5+ Typst source and rendered PDF) that are individually deposited on Zenodo
6+ with a DOI. There is no source code, no build system, and no runtime
7+ component.
138
14- ## Layout
9+ === Layout
1510
16- ```
11+ ....
1712.
1813├── README.md # index of published notes (title, date, DOI)
1914├── <note-slug>.md # note source (Markdown)
@@ -24,18 +19,18 @@ runtime component.
2419│ # CC-BY-SA-4.0; individual notes carry
2520│ # their own licence at Zenodo-deposit time
2621└── .github/ # CI wrappers (governance, security scan)
27- ```
22+ ....
2823
29- ## The invariant
24+ === The invariant
3025
3126Every note listed in the README resolves to a real, citable Zenodo
3227record. If that link breaks, the repo has failed at its one job.
3328
34- ## Publishing flow
29+ === Publishing flow
3530
36- There is no runtime to diagram; the only "flow" is authorial:
31+ There is no runtime to diagram; the only "` flow` " is authorial:
3732
38- ```
33+ ....
3934draft note (.md [+ .typ -> .pdf])
4035 |
4136 v
@@ -44,16 +39,16 @@ draft note (.md [+ .typ -> .pdf])
4439 v
4540 Zenodo deposit (direct API today; GitHub Release once the
4641 Zenodo-GitHub integration is enabled — see README § Zenodo archiving)
47- ```
42+ ....
4843
49- ## Out of scope
44+ === Out of scope
5045
5146* No source code, package, or binary is built or shipped from this repo.
5247* No API, service, or CLI.
5348* No automated test suite — there is no code to exercise.
5449
55- ## See also
50+ === See also
5651
57- * [ docs/usage.adoc] ( docs/usage.adoc ) — how to cite a note.
58- * [ docs/contributing.adoc] ( docs/contributing.adoc ) — how to add a new note.
59- * [ docs/decisions/] ( docs/decisions/ ) — ADRs, historical record of why this shape.
52+ * docs/usage.adoc — how to cite a note.
53+ * docs/contributing.adoc — how to add a new note.
54+ * docs/decisions/ — ADRs, historical record of why this shape.
0 commit comments