From bbc0b743b829da4671dc39e639f5881ab8de7d94 Mon Sep 17 00:00:00 2001 From: hyperpolymath <6759885+hyperpolymath@users.noreply.github.com> Date: Thu, 25 Jun 2026 20:42:46 +0100 Subject: [PATCH] docs(readme): convert README.adoc -> Markdown README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- README.adoc | 83 ------------------------------------------------ README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 83 deletions(-) delete mode 100644 README.adoc create mode 100644 README.md diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 42ff493..0000000 --- a/README.adoc +++ /dev/null @@ -1,83 +0,0 @@ -// SPDX-License-Identifier: CC-BY-SA-4.0 -// README.adoc -- live-files: RSR 2026 Control Plane -= live-files -image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=openssourcesecurity[OpenSSF Best Practices,link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/live-files"] - -Jonathan D.A. Jewell -:toc: macro -:toclevels: 2 -:license: MPL-2.0 -:url-repo: https://github.com/hyperpolymath/live-files - -image:https://img.shields.io/badge/license-MPL--2.0-blue[License,link=LICENSE] -image:https://img.shields.io/badge/RSR-compliant-brightgreen[RSR Compliant] -image:https://github.com/hyperpolymath/live-files/actions/workflows/hypatia-scan.yml/badge.svg[Hypatia Scan,link=https://github.com/hyperpolymath/live-files/actions/workflows/hypatia-scan.yml] - -toc::[] - -== Overview - -**live-files** is the RSR 2026 Control Plane for the Hyperpolymath Epistemic Fleet. -It contains the orchestration logic for all satellite and core repos, managing the -tier-based organisational structure of 275+ repositories across the ecosystem. - -== Features - -* **Filing logic** (`just file`) -- Moves root-level repos into their correct tiers - (Core, Governance, Infrastructure, SSG, MCP, Research) -* **Restoration** (`must restore`) -- Fixes symlinks and directory structures -* **Visibility** (`just v`) -- Two-ply colour-coded map of the Epistemic Fleet -* **Tier mapping** -- Hierarchical organisation of the entire repo ecosystem - -== Quick Start - -[source,bash] ----- -# View the Epistemic Fleet map -just v - -# File repos into their correct tiers -just file - -# Restore broken symlinks -./must restore ----- - -== Project Structure - -[source] ----- -live-files/ -+-- 0-AI-MANIFEST.a2ml # AI agent entry point -+-- Justfile # Task runner (no Makefiles) -+-- must # Restoration utility -+-- scripts/ -| +-- map_ecosystem.sh # Colour-coded fleet map -+-- .machine_readable/ # SCM metadata files -| +-- .machine_readable/6a2/STATE.a2ml -| +-- .machine_readable/6a2/META.a2ml -| +-- .machine_readable/6a2/ECOSYSTEM.a2ml -| +-- .machine_readable/6a2/AGENTIC.a2ml -| +-- .machine_readable/6a2/NEUROSYM.a2ml -| +-- .machine_readable/6a2/PLAYBOOK.a2ml -+-- .well-known/ # Protocol files -| +-- security.txt -| +-- humans.txt -| +-- ai.txt -+-- .github/ - +-- workflows/ # CI/CD workflows - +-- CODEOWNERS ----- - -== Standards - -* No Makefiles -- uses Just/Nickel only -* Oxford British English throughout -* nerdctl for all container tasks -* MPL-2.0 licence - -== Licence - -This project is licensed under the link:LICENSE[Palimpsest Licence (MPL-2.0)]. - -Copyright (c) 2025-2026 Jonathan D.A. Jewell (hyperpolymath) diff --git a/README.md b/README.md new file mode 100644 index 0000000..14dd204 --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ + + +Jonathan D.A. Jewell \<[j.d.a.jewell@open.ac](j.d.a.jewell@open.ac).uk\> +:toc: macro :toclevels: 2 :license: MPL-2.0 :url-repo: + + +[![License](https://img.shields.io/badge/license-MPL--2.0-blue)](LICENSE) ![RSR +Compliant](https://img.shields.io/badge/RSR-compliant-brightgreen) [![Hypatia Scan](https://github.com/hyperpolymath/live-files/actions/workflows/hypatia-scan.yml/badge.svg)](https://github.com/hyperpolymath/live-files/actions/workflows/hypatia-scan.yml) + +
+ +
+ +# Overview + +**live-files** is the RSR 2026 Control Plane for the Hyperpolymath +Epistemic Fleet. It contains the orchestration logic for all satellite +and core repos, managing the tier-based organisational structure of 275+ +repositories across the ecosystem. + +# Features + +- **Filing logic** (`just` `file`) — Moves root-level repos into their + correct tiers (Core, Governance, Infrastructure, SSG, MCP, Research) + +- **Restoration** (`must` `restore`) — Fixes symlinks and directory + structures + +- **Visibility** (`just` `v`) — Two-ply colour-coded map of the + Epistemic Fleet + +- **Tier mapping** — Hierarchical organisation of the entire repo + ecosystem + +# Quick Start + +```bash +# View the Epistemic Fleet map +just v + +# File repos into their correct tiers +just file + +# Restore broken symlinks +./must restore +``` + +# Project Structure + + live-files/ + +-- 0-AI-MANIFEST.a2ml # AI agent entry point + +-- Justfile # Task runner (no Makefiles) + +-- must # Restoration utility + +-- scripts/ + | +-- map_ecosystem.sh # Colour-coded fleet map + +-- .machine_readable/ # SCM metadata files + | +-- .machine_readable/6a2/STATE.a2ml + | +-- .machine_readable/6a2/META.a2ml + | +-- .machine_readable/6a2/ECOSYSTEM.a2ml + | +-- .machine_readable/6a2/AGENTIC.a2ml + | +-- .machine_readable/6a2/NEUROSYM.a2ml + | +-- .machine_readable/6a2/PLAYBOOK.a2ml + +-- .well-known/ # Protocol files + | +-- security.txt + | +-- humans.txt + | +-- ai.txt + +-- .github/ + +-- workflows/ # CI/CD workflows + +-- CODEOWNERS + +# Standards + +- No Makefiles — uses Just/Nickel only + +- Oxford British English throughout + +- nerdctl for all container tasks + +- MPL-2.0 licence + +# Licence + +This project is licensed under the [Palimpsest Licence +(MPL-2.0)](LICENSE). + +Copyright (c) 2025-2026 Jonathan D.A. Jewell (hyperpolymath) +\<[j.d.a.jewell@open.ac](j.d.a.jewell@open.ac).uk\>