Skip to content

Commit bb26bca

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

27 files changed

Lines changed: 618 additions & 513 deletions

‎.github/CONTRIBUTING.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
git clone https://github.com/hyperpolymath/affinescriptiser.git
33
cd affinescriptiser
44

5-
# Using Nix (recommended for reproducibility)
6-
nix develop
5+
# Using Guix (recommended for reproducibility)
6+
guix develop
77

88
# Or using toolbox/distrobox
99
toolbox create affinescriptiser-dev
@@ -45,7 +45,7 @@ affinescriptiser/
4545
├── MAINTAINERS.md
4646
├── README.adoc
4747
├── SECURITY.md
48-
├── flake.nix # Nix flake — fallback (Perimeter 1)
48+
├── flake.guix # Guix flake — fallback (Perimeter 1)
4949
├── guix.scm # Guix package — primary (Perimeter 1)
5050
└── Justfile # Task runner (Perimeter 1)
5151
```

‎.github/copilot-instructions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333

3434
## Banned Languages
3535

36-
- No TypeScript (use ReScript)
36+
- No TypeScript (use AffineScript)
3737
- No Node.js / npm / bun (use Deno)
3838
- No Go (use Rust)
3939
- No Python (use Julia or Rust)

‎.github/dependabot.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ updates:
4141
schedule:
4242
interval: "weekly"
4343

44-
# Nix flakes
45-
- package-ecosystem: "nix"
44+
# Guix flakes
45+
- package-ecosystem: "guix"
4646
directory: "/"
4747
schedule:
4848
interval: "weekly"

‎.machine_readable/ai/PLACEHOLDERS.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ sed -i "s/{{CURRENT_DATE}}/$(date +%Y-%m-%d)/g" $(grep -rl '{{CURRENT_DATE}}' .)
4848

4949
| Placeholder | Description | Example | Files |
5050
|---|---|---|---|
51-
| `{{PROJECT_NAME}}` | Human-readable project name | `My Project` | SECURITY.md, CODE_OF_CONDUCT.md, TOPOLOGY.md, STATE.a2ml, Justfile, GOVERNANCE.md, MAINTAINERS.md, flake.nix, devcontainer.json |
52-
| `{{PROJECT_DESCRIPTION}}` | One-line description | `A tool for X` | flake.nix |
51+
| `{{PROJECT_NAME}}` | Human-readable project name | `My Project` | SECURITY.md, CODE_OF_CONDUCT.md, TOPOLOGY.md, STATE.a2ml, Justfile, GOVERNANCE.md, MAINTAINERS.md, flake.guix, devcontainer.json |
52+
| `{{PROJECT_DESCRIPTION}}` | One-line description | `A tool for X` | flake.guix |
5353
| `{{PROJECT}}` | Uppercase identifier (for Idris2 modules, C macros) | `MY_PROJECT` | ABI-FFI-README.md, src/interface/abi/*.idr, src/interface/ffi/*.zig |
5454
| `{{project}}` | Lowercase identifier (for C symbols, filenames) | `my_project` | ABI-FFI-README.md, src/interface/ffi/*.zig |
5555
| `affinescriptiser` | Repository name (slug) | `my-project` | CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md, cliff.toml |
@@ -133,7 +133,7 @@ After replacing all placeholders, verify none remain:
133133
```bash
134134
grep -rn '{{' . --include='*.md' --include='*.adoc' --include='*.a2ml' \
135135
--include='*.scm' --include='*.idr' --include='*.zig' --include='*.res' \
136-
--include='Justfile' --include='*.nix' --include='*.toml' --include='*.yml' \
136+
--include='Justfile' --include='*.guix' --include='*.toml' --include='*.yml' \
137137
--include='*.yaml' --include='*.hs' --include='*.ncl' --include='*.txt' \
138138
--include='*.json' --include='Containerfile' --include='dep5' \
139139
| grep -v 'PLACEHOLDERS.md' | grep -v 'node_modules'

‎.machine_readable/contractiles/lust/Intentfile.a2ml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ design philosophy — not current state, but target state.
1616

1717
### reproducible-builds
1818
- description: Builds should be bit-for-bit reproducible
19-
- target: Guix + Nix + Containerfile
19+
- target: Guix + Guix + Containerfile
2020
- status: aspiration
2121

2222
### zero-dangerous-patterns

‎.machine_readable/policies/MAINTENANCE-CHECKLIST.a2ml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ compliance-seams-check = true
6767
exception-register-required = true
6868
exception-bounded-scope-required = true
6969
policy-drift-contamination-check = true
70-
example-drift-risk = "single TypeScript exception causing broad ReScript->TypeScript migration"
70+
example-drift-risk = "single TypeScript exception causing broad AffineScript->TypeScript migration"
7171
compliance-tooling = "panic-attack"
7272
effects-tooling = "ecological checking with sustainabot guidance"
7373

‎CODE_OF_CONDUCT.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
== Contributor Covenant Code of Conduct
2+
3+
=== Our Pledge
4+
5+
We pledge to make participation a harassment-free experience for
6+
everyone.
7+
8+
=== Our Standards
9+
10+
*Positive behavior:* * Using welcoming language * Being respectful of
11+
differing viewpoints * Accepting constructive criticism * Focusing on
12+
what is best for the community
13+
14+
*Unacceptable behavior:* * Harassment, trolling, or personal attacks *
15+
Publishing private information without permission
16+
17+
=== Enforcement
18+
19+
Report issues to the maintainers. All complaints will be reviewed.
20+
21+
=== Attribution
22+
23+
Adapted from https://www.contributor-covenant.org/[Contributor Covenant]
24+
v2.1.

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.adoc‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
== Contributing
2+
3+
Thank you for your interest in contributing! We follow a "`Dual-Track`"
4+
architecture where human-readable documentation lives in the root and
5+
machine-readable policies live in `+.machine_readable/+`.
6+
7+
=== How to Contribute
8+
9+
We welcome contributions in many forms:
10+
11+
* *Code:* Improving the core stack or extensions
12+
* *Documentation:* Enhancing docs or AI manifests
13+
* *Testing:* Adding property-based tests or formal proofs
14+
* *Bug reports:* Filing clear, reproducible issues
15+
16+
=== Getting Started
17+
18+
[arabic]
19+
. *Read the AI Manifest:* Start with `+0-AI-MANIFEST.a2ml+` (if present)
20+
to understand the repository structure.
21+
. *Environment:* Use `+guix develop+` or `+direnv allow+` to set up your
22+
tools.
23+
. *Task Runner:* Use `+just+` to see available commands
24+
(`+just --list+`).
25+
26+
=== Development Workflow
27+
28+
==== Branch Naming
29+
30+
....
31+
docs/short-description # Documentation
32+
test/what-added # Test additions
33+
feat/short-description # New features
34+
fix/issue-number-description # Bug fixes
35+
refactor/what-changed # Code improvements
36+
security/what-fixed # Security fixes
37+
....
38+
39+
==== Commit Messages
40+
41+
We follow https://www.conventionalcommits.org/[Conventional Commits]:
42+
43+
....
44+
<type>(<scope>): <description>
45+
46+
[optional body]
47+
48+
[optional footer]
49+
....
50+
51+
Types: `+feat+`, `+fix+`, `+docs+`, `+test+`, `+refactor+`, `+ci+`,
52+
`+chore+`, `+security+`
53+
54+
=== Reporting Bugs
55+
56+
Before reporting: 1. Search existing issues 2. Check if it’s already
57+
fixed in `+main+`
58+
59+
When reporting, include: - Clear, descriptive title - Environment
60+
details (OS, versions, toolchain) - Steps to reproduce - Expected vs
61+
actual behaviour
62+
63+
=== Code of Conduct
64+
65+
All contributors are expected to adhere to our
66+
link:CODE_OF_CONDUCT.md[Code of Conduct].
67+
68+
=== License
69+
70+
By contributing, you agree that your contributions will be licensed
71+
under the same license as the project (see LICENSE).

‎CONTRIBUTING.md‎

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

0 commit comments

Comments
 (0)