Skip to content

Commit 62757ba

Browse files
refactor: migrate Markdown to AsciiDoc (#725)
Automated migration of .md to .adoc per global rules, preserving wikis and critical exceptions.
1 parent 53c96dc commit 62757ba

69 files changed

Lines changed: 5237 additions & 4712 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.

.claude/PROJECT.adoc

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
== AffineScript - Claude Code Instructions
2+
3+
This is the AffineScript compiler, written in OCaml.
4+
5+
=== Project Structure
6+
7+
....
8+
affinescript/
9+
├── lib/ # Core compiler library
10+
│ ├── ast.ml # Abstract syntax tree
11+
│ ├── token.ml # Token definitions
12+
│ ├── lexer.ml # Lexer (sedlex-based)
13+
│ ├── parser.ml # Parser (menhir-based) [TODO]
14+
│ ├── span.ml # Source location tracking
15+
│ └── error.ml # Diagnostics and error handling
16+
├── bin/ # CLI executable
17+
│ └── main.ml # Command-line interface
18+
├── test/ # Test suite
19+
└── docs/ # Documentation
20+
....
21+
22+
=== Build Commands
23+
24+
[source,bash]
25+
----
26+
# Build
27+
dune build
28+
29+
# Run tests
30+
dune runtest
31+
32+
# Format code
33+
dune fmt
34+
35+
# Generate docs
36+
dune build @doc
37+
38+
# Run compiler
39+
dune exec affinescript -- <command> <args>
40+
----
41+
42+
=== Coding Conventions
43+
44+
* Use descriptive variable names
45+
* All files should have type annotations where helpful
46+
* Error messages should follow the format in `+error.ml+`
47+
* Use `+ppx_deriving+` for show, eq, ord on types
48+
* Use `+sexp+` for serialization of AST types
49+
50+
=== Language Specification
51+
52+
The full language specification is at
53+
`+/var$HOME/affinescript-spec.md+`.
54+
55+
Key language features: - *Partial by default*: Functions are partial
56+
unless marked `+total+` - *Quantity annotations*: `+0+` (erased), `+1+`
57+
(linear), `+ω+` (unrestricted) - *Row polymorphism*: `+{x: Int, ..r}+`
58+
for extensible records - *Extensible effects*: User-defined effects with
59+
`+effect+` keyword - *Ownership*: `+own+`, `+ref+`, `+mut+` modifiers
60+
61+
=== Implementation Priority
62+
63+
[arabic]
64+
. Lexer (sedlex) - in progress
65+
. Parser (menhir)
66+
. Name resolution
67+
. Type checker (bidirectional)
68+
. Borrow checker
69+
. Effect checking
70+
. WASM codegen
71+
72+
=== Testing
73+
74+
Tests go in `+test/+` directory. Use Alcotest:
75+
76+
[source,ocaml]
77+
----
78+
let test_something () =
79+
Alcotest.(check string) "description" expected actual
80+
----

.claude/PROJECT.md

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

ARCHITECTURE.adoc

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
== Architecture
2+
3+
=== Overview
4+
5+
This repository follows a modular, maintainable architecture designed
6+
for clarity, scalability, and long-term sustainability.
7+
8+
=== Directory Structure
9+
10+
....
11+
.
12+
├── src/ # Source code
13+
├── tests/ # Test suites
14+
├── docs/ # Documentation
15+
├── scripts/ # Utility scripts
16+
├── config/ # Configuration files
17+
├── LICENSE # License file
18+
├── LICENSES/ # Full license texts
19+
└── README.adoc # Project documentation
20+
....
21+
22+
=== Design Principles
23+
24+
* *Separation of Concerns*: Each module has a single responsibility
25+
* *Testability*: Code is written to be easily testable
26+
* *Documentation*: All public APIs are documented
27+
* *Configuration*: Environment-specific settings are externalized
28+
29+
=== Dependencies
30+
31+
* External dependencies are minimized and clearly declared
32+
* Version pinning is used for reproducibility
33+
34+
=== Security Considerations
35+
36+
* Sensitive data is never committed to the repository
37+
* Secrets are managed through environment variables or secure vaults
38+
* Regular dependency audits are performed
39+
40+
=== Maintainability
41+
42+
* Code follows consistent style guidelines
43+
* Pull requests require review and CI checks
44+
* Issues and discussions are tracked transparently
45+
46+
'''''
47+
48+
_Last updated: 2026-07-18_

ARCHITECTURE.md

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

0 commit comments

Comments
 (0)