aesthetic.computer
Monorepo for Aesthetic.Computer
aesthetic.computer
1# Aesthetic Computer Documentation System
2
3## Overview
4This folder serves as the central documentation hub for Aesthetic Computer, covering:
5
61. **JavaScript API Reference** - The interface provided by `disk.mjs` to AC pieces
72. **KidLisp Language Reference** - Syntax and functions for the KidLisp programming language
83. **Piece Documentation** - How to create and structure AC pieces
94. **System Architecture** - Understanding the AC ecosystem
105. **Development Tools** - CLI tools and development workflows
11
12## Documentation Status & Coverage
13
14### Current State
15- **docs.js**: Comprehensive but manually maintained API docs for web interface
16- **disk.mjs**: 9940 lines of API implementation, needs dynamic analysis
17- **kidlisp.mjs**: 10085 lines with embedded LLM API spec, well documented
18- **prompt.mjs**: Command list for piece discovery and LLM integration
19
20### Goals
21- [ ] Dynamic API surface analysis system
22- [ ] Automated documentation coverage reporting
23- [ ] Test suite for validating API documentation
24- [ ] Integrated CLI documentation explorer for Emacs
25- [ ] Centralized piece documentation system
26
27## Folder Structure
28
29```
30reference/
31├── README.md (this file)
32├── TODO.md (tracking documentation work)
33├── api/
34│ ├── javascript-api.md (disk.mjs API reference)
35│ ├── analysis/ (dynamic API analysis tools)
36│ └── coverage/ (documentation coverage reports)
37├── kidlisp/
38│ ├── language-reference.md (KidLisp syntax guide)
39│ ├── functions.md (built-in functions)
40│ └── examples/ (example KidLisp programs)
41├── pieces/
42│ ├── structure.md (how pieces work)
43│ ├── templates/ (piece templates)
44│ └── catalog/ (documented pieces)
45├── system/
46│ ├── architecture.md (AC system overview)
47│ ├── boot-sequence.md (initialization process)
48│ └── networking.md (socket/session systems)
49├── tools/
50│ ├── cli-explorer.md (emacs docs integration)
51│ ├── testing.md (documentation testing)
52│ └── scripts/ (analysis and validation tools)
53└── ableton/ (existing Ableton Live integration docs)
54 └── ... (current ableton files moved here)
55```
56
57## Next Steps
58
591. **Create folder structure** with proper organization
602. **Move existing Ableton docs** to dedicated subfolder
613. **Set up analysis tools** for dynamic API discovery
624. **Create documentation templates** for consistent formatting
635. **Integrate with development workflow** via Emacs and CLI tools
64
65## Integration Points
66
67- **docs.js**: Web-based API documentation endpoint
68- **prompt.mjs**: Command discovery and piece launching
69- **kidlisp-tools**: CLI tools for KidLisp development
70- **Emacs configuration**: 'docs' tab for reference browsing
71- **VS Code extension**: Documentation integration for development
72
73This system will provide comprehensive, up-to-date documentation that grows with the codebase and supports both interactive exploration and development workflows.