Skip to content

Commit e1347cd

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

224 files changed

Lines changed: 26387 additions & 24143 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

ARCHITECTURE.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
== Architecture
2+
3+
The architecture documentation for ECHIDNA lives in
4+
link:docs/ARCHITECTURE.md[`+docs/ARCHITECTURE.md+`] — the polyglot
5+
layout, the dispatch path, the trust-hardening pipeline, and how the
6+
Rust core, Julia ML sidecar, Idris2 ABI, Zig FFI and optional Chapel
7+
parallel layer fit together.
8+
9+
Related canonical documents:
10+
11+
* link:docs/PROVER_COUNT.md[`+docs/PROVER_COUNT.md+`] — backend tier
12+
table and what each published count actually counts
13+
* link:docs/ROADMAP.md[`+docs/ROADMAP.md+`] — stage map and current
14+
direction
15+
* link:docs/DEBT.md[`+docs/DEBT.md+`] — known licence, documentation and
16+
code debt
17+
* link:.machine_readable/descriptiles/META.a2ml[`+.machine_readable/descriptiles/META.a2ml+`]
18+
— the machine-readable architecture record

ARCHITECTURE.md

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

AUTHORS.adoc

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
== Authors and Contributors
2+
3+
This file lists the authors and contributors to the ECHIDNA project. The
4+
authoritative running list lives in the git history —
5+
`+git shortlog -sne+` will produce a deduplicated, frequency-sorted view
6+
at any commit.
7+
8+
=== Maintainers
9+
10+
[width="100%",cols="34%,33%,33%",options="header",]
11+
|===
12+
|Name |Role |Contact
13+
|Jonathan D.A. Jewell |Lead Maintainer
14+
|https://github.com/hyperpolymath[@hyperpolymath],
15+
`+j.d.a.jewell@open.ac.uk+`
16+
|===
17+
18+
See link:MAINTAINERS.adoc[`+MAINTAINERS.adoc+`] for the maintainer
19+
responsibility model and the path to becoming a maintainer.
20+
21+
=== Contributors
22+
23+
Code, documentation, infrastructure, review, issue triage. The
24+
deduplicated running list is in the git history:
25+
26+
[source,bash]
27+
----
28+
git shortlog -sne
29+
----
30+
31+
We recognise all forms of contribution including but not limited to:
32+
33+
* Code contributions
34+
* Documentation improvements
35+
* Bug reports and testing
36+
* Feature suggestions
37+
* Community support
38+
* Translations
39+
* Design and artwork
40+
* Infrastructure and tooling
41+
42+
=== Special Thanks
43+
44+
* *The theorem-proving community* — for the foundations and the ongoing
45+
maintenance of the backends ECHIDNA integrates with (Coq/Rocq, Lean,
46+
Agda, Isabelle, Idris2, F*, HOL Light, Mizar, PVS, ACL2, HOL4, Z3, CVC5,
47+
Vampire, E Prover, and the long tail in
48+
link:docs/PROVER_COUNT.md[`+docs/PROVER_COUNT.md+`]).
49+
* *The Rhodium Standard Repository (RSR/CCCP)* — for the compliance
50+
template that this repo extends; see
51+
link:RSR_COMPLIANCE.adoc[`+RSR_COMPLIANCE.adoc+`].
52+
53+
=== How to be added
54+
55+
If you’ve contributed to ECHIDNA and would like to be acknowledged
56+
beyond the git history, open an issue or PR on
57+
https://github.com/hyperpolymath/echidna/issues[GitHub] with the
58+
attribution you would like.
59+
60+
=== License of contributions
61+
62+
Source files are licensed per the SPDX header at the top of each file;
63+
the project root link:LICENSE[`+LICENSE+`] and the per-tree
64+
link:.reuse/dep5[`+.reuse/dep5+`] catalogue together describe the
65+
authoritative position. By contributing you agree to license your
66+
contribution under the licence noted on the file you touch (or the
67+
project default for new files).
68+
69+
The documentation surface is intentionally `+MPL-2.0+` — see
70+
https://github.com/hyperpolymath/echidna/issues?q=license[`+feedback_echidna_license_docs_mpl_intentional+`]
71+
for the deliberation.
72+
73+
=== Contact
74+
75+
* *GitHub Issues*: https://github.com/hyperpolymath/echidna/issues
76+
* *Security*: see link:SECURITY.md[`+SECURITY.md+`] — use GitHub
77+
Security Advisories for vulnerabilities, not public issues.
78+
79+
'''''
80+
81+
_This file is intentionally count-free and date-free in prose. The git
82+
history is the running timeline; the canonical attribution surface is
83+
`+git shortlog -sne+`._

AUTHORS.md

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

0 commit comments

Comments
 (0)