Skip to content

Commit fe56bd2

Browse files
hyperpolymathclaude
hyperpolymath
and
claude
authored
Add README.adoc and ROADMAP.adoc for project specification (#2)
- README.adoc: Documents current project state (specification pending), lists components (MAA Framework, Oblíbený language, Aletheia microkernel), covers project scope, infrastructure, and language policy summary - ROADMAP.adoc: Outlines 6 development phases from foundation through ecosystem, includes architecture vision diagram Both files accurately reflect that this is currently a governance/ infrastructure hub awaiting specification uploads. Co-authored-by: Claude <[email protected]>
1 parent 310d8f4 commit fe56bd2

File tree

2 files changed

+222
-0
lines changed

2 files changed

+222
-0
lines changed

‎README.adoc‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,131 @@
1+
// SPDX-License-Identifier: Apache-2.0
12

3+
= MAA Framework
4+
:toc: macro
5+
:toclevels: 3
6+
:icons: font
7+
8+
A full-stack, open-source paradigm for building verifiably-compliant, secure, and sustainable systems.
9+
10+
toc::[]
11+
12+
== Status
13+
14+
[IMPORTANT]
15+
====
16+
*Project Specification* — Implementation forthcoming.
17+
18+
This repository currently serves as the official hub and governance center for the MAA Framework project. Source code, reference implementations, and detailed specifications will be uploaded as development progresses.
19+
====
20+
21+
== Overview
22+
23+
The MAA Framework is an integrated ecosystem comprising:
24+
25+
[cols="1,3"]
26+
|===
27+
|Component |Description
28+
29+
|*MAA Framework*
30+
|Full-stack paradigm for verifiably-compliant, secure, sustainable systems
31+
32+
|*Oblíbený*
33+
|Reference language designed for the framework
34+
35+
|*Aletheia*
36+
|Microkernel implementation
37+
|===
38+
39+
== Project Scope
40+
41+
The framework addresses the following domains:
42+
43+
* *Security & Formal Verification* — Provable correctness guarantees
44+
* *AI Ethics & Axiology* — Value-aligned system design
45+
* *Dependability* — Fault-tolerant, reliable computing
46+
* *Language Design & Compilers* — Purpose-built toolchains
47+
* *Microkernel Architecture* — Minimal trusted computing base
48+
* *RISC-V* — Open hardware architecture support
49+
* *Sustainability* — Resource-efficient computing
50+
* *Economics-as-Code* — Programmable economic primitives
51+
* *Distributed Computing* — BOINC-compatible workloads
52+
* *Reversibility* — Turing-complete/incomplete computation models
53+
* *Web Protocols* — Modern network standards
54+
55+
== Repository Contents
56+
57+
=== Currently Available
58+
59+
[source]
60+
----
61+
.
62+
├── .claude/CLAUDE.md # Language policy (Hyperpolymath Standard)
63+
├── .github/
64+
│ ├── CODEOWNERS # Maintainer assignments
65+
│ └── workflows/ # Multi-forge synchronization
66+
├── README.adoc # This file
67+
├── README.md # Brief description
68+
├── ROADMAP.adoc # Development phases
69+
└── SECURITY.md # Vulnerability reporting policy
70+
----
71+
72+
=== Infrastructure
73+
74+
* *Hub-and-spoke mirroring* to GitLab, Codeberg, Bitbucket
75+
* *SHA-pinned GitHub Actions* for supply chain security
76+
* *SSH host key verification* for MITM protection
77+
* *Minimal permission model* (`contents: read`)
78+
79+
== Language Policy
80+
81+
This project follows the *Hyperpolymath Standard* for technology choices.
82+
83+
.Allowed
84+
[%autowidth]
85+
|===
86+
|Technology |Use Case
87+
88+
|ReScript |Primary application code
89+
|Deno |Runtime & package management
90+
|Rust |Performance-critical, systems, WASM
91+
|Tauri 2.0+ / Dioxus |Mobile applications
92+
|Gleam |Backend services (BEAM/JS)
93+
|Guile Scheme |State/meta files
94+
|===
95+
96+
.Not Permitted
97+
[%autowidth]
98+
|===
99+
|Banned |Replacement
100+
101+
|TypeScript |ReScript
102+
|Node.js / npm / Bun |Deno
103+
|Go |Rust
104+
|Kotlin / Swift |Tauri / Dioxus
105+
|===
106+
107+
See link:.claude/CLAUDE.md[CLAUDE.md] for complete policy.
108+
109+
== Mirrors
110+
111+
[horizontal]
112+
GitHub:: https://github.com/hyperpolymath/maa-framework[hyperpolymath/maa-framework] *(canonical)*
113+
GitLab:: Synchronized automatically
114+
Codeberg:: Synchronized automatically
115+
Bitbucket:: Synchronized automatically
116+
117+
== Security
118+
119+
See link:SECURITY.md[SECURITY.md] for:
120+
121+
* Vulnerability reporting procedures
122+
* Security measures implemented
123+
* Secret management practices
124+
125+
== License
126+
127+
Apache-2.0 (pending formal declaration)
128+
129+
== Contributing
130+
131+
Contribution guidelines will be established as the project develops. Currently maintained by https://github.com/hyperpolymath[@hyperpolymath].

‎ROADMAP.adoc‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
// SPDX-License-Identifier: Apache-2.0
2+
3+
= MAA Framework Roadmap
4+
:toc:
5+
:icons: font
6+
7+
== Current Status
8+
9+
[NOTE]
10+
====
11+
*Phase 0: Foundation* — Complete
12+
13+
Infrastructure and governance established. Awaiting specification uploads and implementation commencement.
14+
====
15+
16+
== Development Phases
17+
18+
=== Phase 0: Foundation [Complete]
19+
20+
* [x] Repository initialization
21+
* [x] Multi-forge hub-and-spoke mirroring (GitHub → GitLab, Codeberg, Bitbucket)
22+
* [x] Security hardening (SHA-pinned actions, SSH host verification)
23+
* [x] Language policy definition (Hyperpolymath Standard)
24+
* [x] Code ownership and governance structure
25+
26+
=== Phase 1: Specification
27+
28+
* [ ] Upload MAA Framework specification documents
29+
* [ ] Define Oblíbený language grammar and semantics
30+
* [ ] Document Aletheia microkernel architecture
31+
* [ ] Establish formal verification requirements
32+
* [ ] Define API boundaries and interfaces
33+
34+
=== Phase 2: Toolchain Bootstrap
35+
36+
* [ ] Oblíbený lexer/parser (OCaml or Rust)
37+
* [ ] Initial type system implementation
38+
* [ ] REPL for language exploration
39+
* [ ] Build system integration (Guix/Nix)
40+
41+
=== Phase 3: Core Runtime
42+
43+
* [ ] Aletheia microkernel prototype
44+
* [ ] Memory management subsystem
45+
* [ ] IPC mechanisms
46+
* [ ] RISC-V target support
47+
48+
=== Phase 4: Framework Libraries
49+
50+
* [ ] Standard library for Oblíbený
51+
* [ ] Formal verification primitives
52+
* [ ] Economics-as-code modules
53+
* [ ] Distributed computing abstractions (BOINC compatibility)
54+
55+
=== Phase 5: Ecosystem
56+
57+
* [ ] Developer documentation
58+
* [ ] Example applications
59+
* [ ] Community contribution guidelines
60+
* [ ] Package registry (if applicable)
61+
62+
== Architecture Vision
63+
64+
[source]
65+
----
66+
┌─────────────────────────────────────────────────────┐
67+
│ Applications │
68+
├─────────────────────────────────────────────────────┤
69+
│ MAA Framework Libraries │
70+
│ ┌──────────┐ ┌──────────┐ ┌──────────────────────┐ │
71+
│ │ Formal │ │Economics │ │ Distributed │ │
72+
│ │Verificat.│ │ as Code │ │ Computing │ │
73+
│ └──────────┘ └──────────┘ └──────────────────────┘ │
74+
├─────────────────────────────────────────────────────┤
75+
│ Oblíbený │
76+
│ (Reference Language + Compiler) │
77+
├─────────────────────────────────────────────────────┤
78+
│ Aletheia │
79+
│ (Microkernel) │
80+
├─────────────────────────────────────────────────────┤
81+
│ RISC-V │
82+
│ (Hardware Target) │
83+
└─────────────────────────────────────────────────────┘
84+
----
85+
86+
== Timeline
87+
88+
No fixed timeline. Development proceeds as specifications are finalized and resources become available.
89+
90+
== Contributing
91+
92+
Roadmap updates will be coordinated through the canonical GitHub repository. Major phase transitions require maintainer approval.

0 commit comments

Comments
 (0)