Project documentation
Project documentation
This is the canonical OKF v0.2 documentation bundle for gfabasic-rust. Markdown files in this tree are the editable source; the project website is a generated publication.
Documentation policy and overview
- Documentation policy - OKF v0.2 conventions, writing rules, and contributor workflow.
- Documentation overview - Overview of audiences and documentation areas.
- Reference sources - Bibliographic sources and provenance.
Architecture and implementation
- Architecture - System design, decisions, validation, and implementation status.
- AI agent security and trust boundaries - Agent capabilities, untrusted inputs, workflow permissions, secrets, and maintainer controls.
- AI agent contribution evaluation - A small retrospective baseline and evidence-based improvements for agent-assisted PRs.
- Runtime handler registration - Canonical API handler mapping and runtime dispatch validation.
Language and API reference
- Reference - Dialect, API, and feature reference material.
Research and evidence
- Research - Source reviews, inventories, and evidence notes.
- Amiga GFA BASIC command catalogue - Entry point for the extracted Amiga command/function lists, detailed book and OS API extraction, structured inventories, version evidence, and count definitions.
- Amiga GFA BASIC language population policy - Maintainer-approved denominator, normalization, exclusions, evidence and implementation counting rules for issue #307.
- Amiga GFA BASIC Chapter 7 program-handling evidence - Page-cited base-manual inventory for program control, procedures, and error handling; 3.52 probes are a separate evidence dimension.
- Amiga GFA BASIC Chapter 8 graphics compatibility evidence - Page-cited graphics inventory, 3.5 PCOLOR reconciliation, and 3.52 probe coverage boundary.
- Amiga GFA BASIC Chapter 9 event/window evidence - Page-cited event, menu, screen, window and requester inventory; isolates the documented 3.5 OPENW variant.
- Amiga GFA BASIC Chapter 10 advanced programming evidence - Page-cited advanced programming inventory; keeps Amiga-specific facilities and 3.0/3.5/3.52 evidence separate.
- Amiga GFA BASIC Chapter 11 system-routine evidence - Page-cited inventory of seven Amiga OS library groups; distinguishes 3.0 base-manual APIs, 3.5 addendum evidence, and 3.52 runtime probes.
- Amiga GFA BASIC Chapter 12 appendix and index evidence - Page-cited reference-table inventory, AmigaDOS errors, and command/system-call indexes; preserves 3.0/3.5/3.52 evidence boundaries.
- Amiga GFA BASIC test output - Native file-output observation and proposed batch result protocol.
Project use and contribution
- Contributor guides - Development setup and contribution policies.
- User guides - User-facing guidance.
- Testing guides - Reference interpreter and testing material.
- Amiga GFA BASIC probe-writing guide - Rules for version-specific native interpreter probes.
- Version-scoped language-construct catalogue - Exact-version manifests, evidence, expectations, probes, and implementation status.
- Agent Skills - Task-specific procedures for AI coding agents.
- Templates - Reusable documentation structures.