This directory contains all project documentation organized by purpose.
docs/
├── README.adoc # This file
├── specs/ # Language specifications
│ ├── affinescript-spec.md # Complete language specification
│ └── SPEC.adoc # Core specification
├── governance/ # Community and process docs
│ ├── CODE_OF_CONDUCT.md # Community standards
│ ├── CONTRIBUTING.adoc # How to contribute
│ ├── MAINTAINERS.adoc # Project maintainers
│ └── SECURITY.md # Security policy
├── standards/ # Design & planning docs
│ ├── ROADMAP.md # Development roadmap
│ ├── DECISIONS.md # Architecture decisions
│ ├── RELEASE.md # Release procedures
│ ├── TESTING.adoc # Test taxonomy + PR-level gates
│ ├── PANIC-ATTACK.adoc # Security-scan policy & disposition
│ └── PALIMPSEST.adoc # License integration
└── guides/ # Testing and guides
├── TESTING-REPORT.adoc # (RETIRED — redirects to standards/TESTING.adoc)
└── TESTING-REPORT.scm # (RETIRED — redirects to standards/TESTING.adoc)For language designers and implementers.
-
AffineScript Specification - Complete language spec
-
Core Specification - Core language features
-
Typed-WASM Interface (v1) - Formal AS↔typed-wasm contract (carrier, levels, CLI, tests, multi-producer model)
-
Typed-WASM Widening Roadmap - Tranches A–E for making typed-wasm a natural + optimal target
-
Settled Decisions - ADR index
For contributors and community members.
-
Code of Conduct - Community behavior standards
-
Contributing Guide - How to contribute code/docs
-
Maintainers - Who maintains what
-
Security Policy - How to report vulnerabilities
For understanding project direction and decisions.
-
Roadmap - Development roadmap and milestones
-
Architecture Decisions - Key design choices
-
Release Process - How releases are made
-
Palimpsest Integration - License integration
-
Testing Standards - Test taxonomy, gate baseline, PR expectations
-
Panic-Attack Policy - Security-scan SOP and finding disposition
For testing and quality assurance.
-
Capability Matrix - Live per-component readiness (the authoritative status doc)
-
Testing Standards - Test taxonomy, gate baseline, PR expectations
-
Testing Report - RETIRED (2025-12-29 snapshot; redirects to the two above)
…understand AffineScript → Start with Language Specification
…contribute code → Read Contributing Guide
…report a security issue → Follow Security Policy
…understand design decisions → See Architecture Decisions
…check the roadmap → Review Roadmap
…see test coverage → Browse Capability Matrix (live) or Testing Standards (taxonomy + gates)
Documentation improvements are always welcome! See Contributing Guide for:
-
Style guidelines
-
Review process
-
Documentation testing
-
Project Repository: https://github.com/hyperpolymath/affinescript
-
Issue Tracker: https://github.com/hyperpolymath/affinescript/issues
-
Discussions: https://github.com/hyperpolymath/affinescript/discussions
Last updated: 2026-01-23