Skip to content

Commit a408291

Browse files
refactor: migrate Markdown to AsciiDoc (#27)
Automated migration of .md to .adoc per global rules, preserving wikis and critical exceptions.
1 parent 116207e commit a408291

13 files changed

Lines changed: 374 additions & 351 deletions
Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,14 @@
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:
94
it 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

3126
Every note listed in the README resolves to a real, citable Zenodo
3227
record. 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+
....
3934
draft 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.

‎CHANGELOG.adoc‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
== Changelog
2+
3+
All notable changes to `+technical-notes+` will be documented in this
4+
file.
5+
6+
This file is generated from conventional commits by the
7+
https://github.com/hyperpolymath/standards/blob/main/.github/workflows/changelog-reusable.yml[`+changelog-reusable.yml+`]
8+
workflow (`+hyperpolymath/standards#206+`). Adopt the workflow in this
9+
repo’s CI to keep this file in sync automatically — see
10+
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+templates/cliff.toml+`]
11+
for the canonical config.
12+
13+
The format follows https://keepachangelog.com/en/1.1.0/[Keep a
14+
Changelog]; this project aims to follow
15+
https://semver.org/spec/v2.0.0.html[Semantic Versioning].
16+
17+
=== [Unreleased]
18+
19+
==== Fixed
20+
21+
* fix(ci): sync hypatia-scan.yml to canonical (413:
22+
env.HOME+Phase-2+SARIF) (#1)
23+
24+
=== Pre-history
25+
26+
Prior commits to this file’s introduction are recorded in git history
27+
but not formally classified into Keep-a-Changelog sections. To backfill,
28+
run `+git cliff -o CHANGELOG.md+` locally using the canonical
29+
https://github.com/hyperpolymath/standards/blob/main/templates/cliff.toml[`+cliff.toml+`]
30+
— this is one-shot mechanical work.
31+
32+
'''''

‎CHANGELOG.md‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎CONTRIBUTING.adoc‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
== Contributing to technical-notes
2+
3+
Thanks for your interest. This repository follows the Hyperpolymath
4+
estate standards defined in
5+
https://github.com/hyperpolymath/standards[hyperpolymath/standards].
6+
7+
=== Licence
8+
9+
This project is licensed under *MPL-2.0*. By contributing you agree that
10+
your contributions are licensed under the same terms. Every source file
11+
carries an `+SPDX-License-Identifier+` header; keep it when editing, and
12+
add one to any new file.
13+
14+
=== Development environment
15+
16+
A pinned dev shell is provided:
17+
18+
[source,sh]
19+
----
20+
nix develop # toolchain: git
21+
----
22+
23+
Estate policy is Guix primary / Nix fallback; this repo currently ships
24+
the Nix fallback. A `+guix.scm+` is welcome if you prefer the primary
25+
tier.
26+
27+
=== Language policy
28+
29+
The estate restricts which languages may be used. In particular Python,
30+
Go, TypeScript, ReScript, V-lang, Java/Kotlin, Swift and Makefiles are
31+
*not* accepted in new code; AffineScript, Rust/SPARK, Zig, Deno, Gleam,
32+
Elixir, Haskell, Idris2, Agda, Julia and OCaml are. CI enforces this, so
33+
check the policy in `+hyperpolymath/standards+` before introducing a new
34+
language.
35+
36+
=== Documentation format
37+
38+
Docs are AsciiDoc (`+.adoc+`) by default, including `+README.adoc+`. The
39+
GitHub-required community-health files stay Markdown: `+SECURITY.md+`,
40+
`+CONTRIBUTING.md+`, `+CODE_OF_CONDUCT.md+`, `+CHANGELOG.md+`. Do not
41+
add a `+.md+` duplicate of a doc that already exists as `+.adoc+`.
42+
43+
=== Pull requests
44+
45+
[arabic]
46+
. Branch from `+main+` — do not push to `+main+` directly; branch
47+
protection requires review and passing checks.
48+
. Keep the change focused, and explain _why_ in the PR body.
49+
. Make sure governance CI is green. It checks documentation presence,
50+
packaging policy, secrets, licence consistency and workflow security.
51+
. Security issues: follow `+SECURITY.md+` — report privately, never in a
52+
public issue.

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 50 deletions
This file was deleted.

‎GOVERNANCE.adoc‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
== Governance
2+
3+
`+technical-notes+` is a single-maintainer repository in the
4+
`+hyperpolymath+` estate. There is no multi-maintainer or RFC process
5+
here; estate-wide policy lives in
6+
https://github.com/hyperpolymath/standards[`+hyperpolymath/standards+`].
7+
8+
=== Maintainer
9+
10+
See link:MAINTAINERS[`+MAINTAINERS+`] for who currently maintains this
11+
repo.
12+
13+
=== Decision making
14+
15+
The maintainer accepts, revises, or declines contributions directly. A
16+
non-trivial process change — how notes are drafted, versioned, or
17+
archived — is recorded as an ADR in
18+
link:docs/decisions/[`+docs/decisions/+`] rather than decided ad hoc.
19+
20+
=== Licensing
21+
22+
* Repository tooling and process documentation: MPL-2.0 or CC-BY-SA-4.0
23+
per the SPDX header on each file (see `+LICENSE+` / `+LICENSES/+`).
24+
* Each published note carries its own licence, set at Zenodo-deposit
25+
time and recorded in that note’s Zenodo metadata (see the root
26+
`+README.md+` § Licence).
27+
28+
=== CI-enforced governance
29+
30+
SPDX-header presence, licence consistency, secrets scanning, and
31+
workflow security are enforced by the shared reusable workflow in
32+
`+hyperpolymath/standards+`; see
33+
link:.github/workflows/governance.yml[`+.github/workflows/governance.yml+`]
34+
and
35+
link:.github/workflows/hypatia-scan.yml[`+.github/workflows/hypatia-scan.yml+`].
36+
37+
=== Communication
38+
39+
* *Issues*: bugs or gaps in this repo — broken DOI links, wrong
40+
citations, process gaps.
41+
* *Pull requests*: proposed changes; see
42+
link:CONTRIBUTING.md[`+CONTRIBUTING.md+`].
43+
* *Security*: follow estate policy in `+hyperpolymath/standards+` — do
44+
not file security-relevant findings as public issues.

‎GOVERNANCE.md‎

Lines changed: 0 additions & 49 deletions
This file was deleted.

‎README.adoc‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
== technical-notes
2+
3+
Citable short technical notes and observations — AI accountability,
4+
agent behaviour, software engineering. Each note is archived on
5+
https://zenodo.org/[Zenodo] with a DOI.
6+
7+
=== Notes
8+
9+
[width="100%",cols="14%,12%,41%,33%",options="header",]
10+
|===
11+
|Note |Date |Cite (concept DOI) |Latest version
12+
|link:agent-self-review-precommit.md[Pre-execution self-review catching
13+
a self-introduced state-threading defect in an autonomous
14+
code-remediation agent] (link:agent-self-review-precommit.pdf[PDF])
15+
|2026-05-16
16+
|https://doi.org/10.5281/zenodo.20245468[10.5281/zenodo.20245468] |v2 —
17+
https://doi.org/10.5281/zenodo.20246057[10.5281/zenodo.20246057]
18+
|===
19+
20+
____
21+
Cite the *concept DOI* (`+10.5281/zenodo.20245468+`) — it always
22+
resolves to the latest version. v1 = `+10.5281/zenodo.20245469+`.
23+
____
24+
25+
=== Zenodo archiving
26+
27+
This repo is intended to be connected to the Zenodo–GitHub integration
28+
(Zenodo → _GitHub_ settings → enable this repository). After that,
29+
*every GitHub Release* auto-deposits a new version, grouped under a
30+
single _concept DOI_ so versions stay citable as "`latest`". The note
31+
above was deposited directly via the Zenodo API as a standalone record
32+
before the integration was wired; future notes (and new versions) should
33+
go via a GitHub Release.
34+
35+
=== Licence
36+
37+
Content is licensed link:LICENSE[CC-BY-4.0].

0 commit comments

Comments
 (0)