From d3abce64c2a94667d5716f8714cdeef7a51066ec Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Mon, 24 Aug 2026 08:05:25 +0100 Subject: [PATCH] refactor: migrate repository documentation from Markdown to AsciiDoc --- GOVERNANCE.adoc | 60 +++++++++++++++++++++++++++++++++++++++++++++ GOVERNANCE.md | 60 --------------------------------------------- examples/about.adoc | 10 ++++++++ examples/about.md | 12 --------- examples/index.adoc | 33 +++++++++++++++++++++++++ examples/index.md | 30 ----------------------- 6 files changed, 103 insertions(+), 102 deletions(-) create mode 100644 GOVERNANCE.adoc delete mode 100644 GOVERNANCE.md create mode 100644 examples/about.adoc delete mode 100644 examples/about.md create mode 100644 examples/index.adoc delete mode 100644 examples/index.md diff --git a/GOVERNANCE.adoc b/GOVERNANCE.adoc new file mode 100644 index 0000000..9b836fb --- /dev/null +++ b/GOVERNANCE.adoc @@ -0,0 +1,60 @@ +== Governance + +=== Overview + +This project is governed by the following principles and structures to +ensure transparent, inclusive, and effective decision-making. + +=== Roles and Responsibilities + +==== Maintainers + +Maintainers are responsible for: - Reviewing and merging pull requests - +Managing releases and versioning - Ensuring code quality and standards - +Triaging issues and bug reports - Community engagement and support + +==== Contributors + +Contributors are expected to: - Follow the code of conduct - Submit +well-documented pull requests - Write tests for new functionality - +Maintain existing tests - Update documentation as needed + +=== Decision Making + +==== Minor Changes + +* Can be made by any maintainer +* Include bug fixes, documentation updates, dependency updates + +==== Major Changes + +* Require discussion in issues or pull requests +* Include new features, architectural changes, API changes +* Need approval from at least 2 maintainers + +==== Breaking Changes + +* Require RFC (Request for Comments) process +* Need approval from majority of maintainers +* Must include migration guide + +=== Code of Conduct + +All participants are expected to follow our Code of Conduct. Violations +can be reported to the maintainers. + +=== Communication + +* *Issues*: For bug reports and feature requests +* *Discussions*: For questions and general discussion +* *Pull Requests*: For code contributions + +=== Licensing + +All contributions are made under the terms of the repository’s LICENSE +file. By submitting a pull request, you agree to license your +contributions accordingly. + +''''' + +_Last updated: 2026-07-18_ diff --git a/GOVERNANCE.md b/GOVERNANCE.md deleted file mode 100644 index e27364c..0000000 --- a/GOVERNANCE.md +++ /dev/null @@ -1,60 +0,0 @@ -# Governance - -## Overview - -This project is governed by the following principles and structures to ensure transparent, inclusive, and effective decision-making. - -## Roles and Responsibilities - -### Maintainers - -Maintainers are responsible for: -- Reviewing and merging pull requests -- Managing releases and versioning -- Ensuring code quality and standards -- Triaging issues and bug reports -- Community engagement and support - -### Contributors - -Contributors are expected to: -- Follow the code of conduct -- Submit well-documented pull requests -- Write tests for new functionality -- Maintain existing tests -- Update documentation as needed - -## Decision Making - -### Minor Changes -- Can be made by any maintainer -- Include bug fixes, documentation updates, dependency updates - -### Major Changes -- Require discussion in issues or pull requests -- Include new features, architectural changes, API changes -- Need approval from at least 2 maintainers - -### Breaking Changes -- Require RFC (Request for Comments) process -- Need approval from majority of maintainers -- Must include migration guide - -## Code of Conduct - -All participants are expected to follow our Code of Conduct. Violations can be reported to the maintainers. - -## Communication - -- **Issues**: For bug reports and feature requests -- **Discussions**: For questions and general discussion -- **Pull Requests**: For code contributions - -## Licensing - -All contributions are made under the terms of the repository's LICENSE file. -By submitting a pull request, you agree to license your contributions accordingly. - ---- - -*Last updated: 2026-07-18* diff --git a/examples/about.adoc b/examples/about.adoc new file mode 100644 index 0000000..59c3026 --- /dev/null +++ b/examples/about.adoc @@ -0,0 +1,10 @@ +== + +title: Getting started site: Ddraig description: How to build a site +with Ddraig. date: 2026-06-22 — + +== Getting started + +[arabic] +. Compile: `+idris2 Ddraig.idr -o ddraig+` +. Build: `+ddraig build examples _site+` diff --git a/examples/about.md b/examples/about.md deleted file mode 100644 index ee726e5..0000000 --- a/examples/about.md +++ /dev/null @@ -1,12 +0,0 @@ - ---- -title: Getting started -site: Ddraig -description: How to build a site with Ddraig. -date: 2026-06-22 ---- - -# Getting started - -1. Compile: `idris2 Ddraig.idr -o ddraig` -2. Build: `ddraig build examples _site` diff --git a/examples/index.adoc b/examples/index.adoc new file mode 100644 index 0000000..b45d38e --- /dev/null +++ b/examples/index.adoc @@ -0,0 +1,33 @@ +== + +title: Ddraig site: Ddraig description: A dependently-typed static-site +generator written in Idris 2. date: 2026-06-22 — + +== Ddraig + +Types that breathe fire. A static-site generator in pure Idris 2. + +____ +Built-in accessible theme, WCAG 2.2 AAA-capable. +____ + +=== Feature matrix + +[cols=",",options="header",] +|=== +|Feature |Status +|Markdown |full +|Tables |yes +|Raw HTML |yes +|=== + +=== Code + +[source,idris] +---- +main : IO () +main = putStrLn "Ddraig" +---- + +See the link:/about.html[getting-started page] and the project +https://github.com/hyperpolymath/ddraig-ssg[README]. diff --git a/examples/index.md b/examples/index.md deleted file mode 100644 index 7a310c1..0000000 --- a/examples/index.md +++ /dev/null @@ -1,30 +0,0 @@ - ---- -title: Ddraig -site: Ddraig -description: A dependently-typed static-site generator written in Idris 2. -date: 2026-06-22 ---- - -# Ddraig - -Types that breathe fire. A static-site generator in pure Idris 2. - -> Built-in accessible theme, WCAG 2.2 AAA-capable. - -## Feature matrix - -| Feature | Status | -|---------|--------| -| Markdown | full | -| Tables | yes | -| Raw HTML | yes | - -## Code - -```idris -main : IO () -main = putStrLn "Ddraig" -``` - -See the [getting-started page](/about.html) and the project [README](https://github.com/hyperpolymath/ddraig-ssg).