Packages

raxol

1.5.4
2.6.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.5.4 1.4.1 1.0.1 1.0.0 0.9.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

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.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
33 Dependencies
2 Dependants
Files
Activity
raxol docs README.md
Raw

docs/README.md 

# Documentation



Navigation for Raxol documentation.



## Quick Navigation



### Essentials

- [Installation](../README.md#installation)

- [Getting Started](getting-started.md)

- [API Reference](api-reference.md)

- [Examples](../examples/README.md)



### Core Documentation

- [Development](development.md)

- [UI Components](components.md)

- [Performance](performance.md)

- [Testing](testing.md)

- [Security](security.md)



### Guides

- [Custom Components](guides/custom_components.md)

- [Performance Optimization](guides/performance_optimization.md)

- [Accessibility](guides/accessibility_implementation_guide.md)

- [Multi-Framework](guides/multi_framework_migration_guide.md)



### Advanced

- [Architecture Decisions](adr/)

- [Benchmarks](bench/)



### Tools & Automation

- Scripts: `scripts/` directory

- CI/CD: `.github/workflows/`



### Standards

- [Naming Conventions](development/NAMING_CONVENTIONS.md)

- [Duplicate Prevention](development/duplicate_filename_prevention.md)



## Quick Links



| Resource | Description |

|----------|-------------|

| [HexDocs](https://hexdocs.pm/raxol) | Official API documentation |

| [GitHub](https://github.com/Hydepwns/raxol) | Source code repository |

| [Issues](https://github.com/Hydepwns/raxol/issues) | Bug reports and features |

| [Changelog](../CHANGELOG.md) | Version history |



## Documentation Structure



```

docs/

├── README.md           # This file - Documentation hub

├── guides/            # User and developer guides

├── development/       # Development documentation

├── adr/              # Architecture Decision Records

├── bench/            # Benchmarking documentation

└── releases/         # Release notes and history

```



## Quick Commands



```bash

# Interactive tutorial

mix raxol.tutorial



# Component playground

mix raxol.playground



# Run tests

mix test



# Run benchmarks

mix run bench/scripts/ansi_parser_bench.exs



# Generate docs

mix docs

```



## Updates



1. Follow existing patterns

2. Update index for new sections

3. Keep examples executable

4. Verify with `mix docs`



---



Questions: [open an issue](https://github.com/Hydepwns/raxol/issues)