Skip to content

Commit b140aac

Browse files
hyperpolymathclaude
andcommitted
docs(readme): convert README.adoc -> Markdown README.md
README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 59a17b3 commit b140aac

2 files changed

Lines changed: 115 additions & 106 deletions

File tree

README.adoc

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

README.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
6+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}/badge)](https://www.bestpractices.dev/projects/{{OPENSSF_PROJECT_ID}}) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/{{OWNER}}/{{REPO}}/badge)](https://securityscorecards.dev/viewer/?uri=github.com/{{OWNER}}/{{REPO}})
7+
8+
> [!NOTE]
9+
> This repository is a template. Placeholder tokens like `{{OWNER}}`,
10+
> `{{REPO}}`, and `{{PROJECT_NAME}}` are expected before running `just`
11+
> `init`.
12+
13+
# Overview
14+
15+
This template now uses a split maintenance model:
16+
17+
- Authoritative session protocols live centrally in
18+
`standards/session-management-standards`.
19+
20+
- This repo keeps only thin local integration (Justfile aliases, local
21+
hooks, coordination bindings, and repo-local checks).
22+
23+
- Runtime session artifacts are generated per working repository in
24+
`.session/`.
25+
26+
# Session Management Integration
27+
28+
Canonical command model:
29+
30+
- `intake` `repo` `<path>`
31+
32+
- `checkpoint` `change` `<path>`
33+
34+
- `verify` `maintenance` `<path>`
35+
36+
- `verify` `substantial` `<path>`
37+
38+
- `verify` `release` `<path>`
39+
40+
- `close` `planned` `<path>`
41+
42+
- `close` `urgent` `<path>`
43+
44+
- `recover` `repo` `<path>`
45+
46+
- `handover` `full` `<path>`
47+
48+
- `handover` `split` `<path>`
49+
50+
- `handover` `model` `<path>`
51+
52+
- `handover` `human` `<path>`
53+
54+
Local binding files in this template:
55+
56+
- `session/dispatch.sh`
57+
58+
- `session/custom-checks.k9`
59+
60+
- `session/local-hooks.sh`
61+
62+
- `session/README.md`
63+
64+
- `coordination.k9`
65+
66+
Run `just` `session-help` for local aliases.
67+
68+
# ABI/FFI Seam Layout
69+
70+
The template keeps a verified interface seam split:
71+
72+
- ABI (Idris2): `src/interface/Abi/*.idr`
73+
74+
- FFI (Zig): `src/interface/ffi/src/*.zig`
75+
76+
- Generated artifacts: `src/interface/generated/`
77+
78+
# Repository Layout
79+
80+
| Path | Purpose |
81+
|----|----|
82+
| `.machine_readable/` | Machine-readable policy and project metadata. |
83+
| `session/` | Thin local bindings to central session-management standards. |
84+
| `coordination.k9` | Local coordination wiring to canonical session commands. |
85+
| `docs/` | Human-facing technical and governance documentation. |
86+
| `src/interface/` | ABI/FFI/generated seam scaffolding. |
87+
| `verification/` | Proof and verification scaffolding. |
88+
89+
# Quick Start
90+
91+
```bash
92+
just init
93+
just verify
94+
just session-help
95+
```
96+
97+
# Documentation
98+
99+
- <a href="AUDIT.adoc" class="adoc">AUDIT</a> — local audit gate summary
100+
101+
- <a href="EXPLAINME.adoc" class="adoc">EXPLAINME</a> — template
102+
claim-to-implementation map
103+
104+
- [session/README.md](session/README.md) — session binding usage
105+
106+
- [docs/governance/README.adoc](docs/governance/README.adoc) — governance
107+
docs index
108+
109+
- <a href="CONTRIBUTING.md" class="md">CONTRIBUTING</a>
110+
111+
- <a href="SECURITY.md" class="md">SECURITY</a>
112+
113+
# License
114+
115+
SPDX-License-Identifier: CC-BY-SA-4.0 See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)