Packages

Multi-surface application runtime for Elixir. One TEA module renders to terminal, browser (LiveView), SSH, and MCP (agents). 30+ widgets, flexbox + CSS grid, AI agent runtime, distributed swarm with CRDTs, time-travel debugging, session recording, sandboxed REPL, and agentic commerce.

Current section

Files

Jump to
raxol docs REMAINING_CRITICAL_UPDATES.md
Raw

docs/REMAINING_CRITICAL_UPDATES.md

# Remaining Critical Documentation Updates
## High Priority
### 1. Version Updates (Quick Wins)
**Files to Update**: Multiple guide files still reference version 0.6.0
- `/examples/guides/01_getting_started/install.md` - Update to 0.8.0
- `/examples/guides/02_core_concepts/api/README.md` - Update version
- `/examples/guides/03_components_and_layout/components/README.md` - Update version
- `/examples/guides/04_extending_raxol/plugin_development.md` - Update version
- `/examples/guides/05_development_and_testing/development/planning/overview.md` - Update version
- `/examples/guides/05_development_and_testing/DevelopmentSetup.md` - Update version
### 2. Component Documentation Updates
**File**: `/docs/components/README.md`
- Add section on web rendering capabilities
- Document component lifecycle in web context
- Include examples of components working in both terminal and web
- Add real-time update patterns
## Medium Priority
### 3. Create Enterprise Features Documentation
**New Directory**: `/examples/guides/06_enterprise/`
- `authentication.md` - Auth setup and user management
- `monitoring.md` - Metrics, telemetry, and monitoring
- `deployment.md` - Production deployment strategies
- `security.md` - Security best practices
- `scaling.md` - Horizontal scaling and clustering
### 4. Update Existing Component Guides
**Directory**: `/examples/guides/03_component_reference/`
- Add web compatibility notes to each component
- Document lifecycle hooks for web context
- Include collaboration features (shared state, cursors)
## Low Priority
### 5. Update Development Guides
- Add web development workflow to existing guides
- Include Phoenix server setup in development docs
- Document debugging techniques for web interface
## Next Steps
1. Start with version updates (quick wins)
2. Focus on component documentation updates
3. Create enterprise documentation structure
4. Review and update any remaining outdated references
## Search Commands to Find More Issues
```bash
# Find remaining "toolkit" references
grep -r "toolkit" --include="*.md" .
# Find remaining old version references
grep -r "0.6.0\|0.7.0" --include="*.md" .
# Find files missing framework positioning
grep -r "TUI library\|terminal user interface" --include="*.md" .
```