Skip to content

Commit 6930568

Browse files
committed
Purge stale TS/VS Code-era docs; finish .adoc migration where unambiguous
Several docs still described the long-dead TypeScript VS Code extension (npm, Jest, Babel, "JS→ReScript patterns") — two host-generations out of date and actively misleading. Rewritten to current reality (correspondence engine; Deno + cartridges runtime; Idris2 ABI + Zig FFI + AffineScript host spine; cartridge authoring as the contribution model; no-shame voice): - docs/RSR_COMPLIANCE.md -> docs/RSR_COMPLIANCE.adoc (accurate + honest; neutral licensing section that defers to LICENSE) - docs/TPCF.md -> docs/TPCF.adoc (perimeter model reframed for cartridges) - CONTRIBUTING.md rewritten in place (kept .md — GitHub-required file) Removed (superseded by a clean .adoc twin): - MAINTAINERS.md (MAINTAINERS.adoc is canonical) References repointed: README badges + links, CODE_OF_CONDUCT.md, SECURITY.md, .github/workflows/ci.yml + .gitlab-ci.yml doc checks, Justfile validate-docs. deno fmt/lint/test/build all green; no dangling links remain. Out of scope (flagged, deliberately untouched): - Licence-label drift (config.ncl "MIT OR Palimpsest", README "Palimpsest License (MPL-2.0)", LICENSE-MIT/PALIMPSEST vs the MPL-2.0 classification) — owner-only per the licence guardrail. - The CONTRIBUTING.md / CHANGELOG.md .md-vs-.adoc choice for GitHub-required files. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01A1BaAhqxUjkgVb1yg1sZap
1 parent 969731d commit 6930568

13 files changed

Lines changed: 282 additions & 1440 deletions

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ jobs:
122122
test -f CONTRIBUTING.md || (echo "Missing CONTRIBUTING.md" && exit 1)
123123
test -f CODE_OF_CONDUCT.md || (echo "Missing CODE_OF_CONDUCT.md" && exit 1)
124124
test -f SECURITY.md || (echo "Missing SECURITY.md" && exit 1)
125-
test -f MAINTAINERS.md || (echo "Missing MAINTAINERS.md" && exit 1)
125+
test -f MAINTAINERS.adoc || (echo "Missing MAINTAINERS.adoc" && exit 1)
126126
test -f CHANGELOG.md || (echo "Missing CHANGELOG.md" && exit 1)
127127
test -f CLAUDE.md || (echo "Missing CLAUDE.md" && exit 1)
128128

.gitlab-ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ rsr-compliance:
9898
echo "Checking RSR Bronze compliance..."
9999
100100
# Documentation
101-
test -f ../README.md || (echo "Missing README.md" && exit 1)
101+
test -f ../README.adoc || (echo "Missing README.adoc" && exit 1)
102102
test -f ../CONTRIBUTING.md || (echo "Missing CONTRIBUTING.md" && exit 1)
103103
test -f ../CODE_OF_CONDUCT.md || (echo "Missing CODE_OF_CONDUCT.md" && exit 1)
104104
test -f ../SECURITY.md || (echo "Missing SECURITY.md" && exit 1)
105-
test -f ../MAINTAINERS.md || (echo "Missing MAINTAINERS.md" && exit 1)
105+
test -f ../MAINTAINERS.adoc || (echo "Missing MAINTAINERS.adoc" && exit 1)
106106
test -f ../CHANGELOG.md || (echo "Missing CHANGELOG.md" && exit 1)
107107
108108
# Licenses

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ This Code of Conduct applies within all community spaces, and also applies when
114114

115115
If you experience or witness unacceptable behavior, or have any other concerns, please report it by contacting the project maintainers at:
116116

117-
- **Email**: See [MAINTAINERS.md](MAINTAINERS.md) for contact information
117+
- **Email**: See [MAINTAINERS.adoc](MAINTAINERS.adoc) for contact information
118118
- **Anonymous Form**: [Coming soon]
119119

120120
All reports will be handled with **discretion and confidentiality**.
@@ -220,7 +220,7 @@ This Code of Conduct is a **living document** and may be updated based on commun
220220

221221
For questions about this Code of Conduct:
222222

223-
- **Maintainers**: See [MAINTAINERS.md](MAINTAINERS.md)
223+
- **Maintainers**: See [MAINTAINERS.adoc](MAINTAINERS.adoc)
224224
- **GitHub Discussions**: [Community forum](https://github.com/Hyperpolymath/nextgen-languages-evangeliser/discussions)
225225

226226
---

0 commit comments

Comments
 (0)