Documentation
Start with the demo or CLI, then use the browser, architecture, development, and specification documents as needed.
Using Avelune
Install the command-line tools and encode, decode, inspect, or verify media.
- CLI guide
Encode, decode, inspect, verify, and maintain Avelune media from the command line.
Browser integration
Byte-range playback, WebAssembly codec APIs, media import, presentation, and browser acceleration.
- Browser streaming contract
Browser decoding, media import, streaming A/V encoding, byte-range transport, and presentation boundaries.
- WebGPU and browser acceleration — Draft Generation 1
Optional WebGPU presentation, experimental codec-compute work, and the boundary between GPU and Rust/WASM responsibilities.
Architecture
Non-normative design direction and engineering decisions around the codec.
- Codec direction (non-normative)
The active, non-normative research direction for Avelune video, audio, and browser architecture.
Development
Conformance, testing, versioning, documentation, and release processes.
- Independent conformance oracle
Why Avelune keeps one independent decoder oracle and how its boundary is protected.
- Testing Avelune
Validation layers and regression policy for the canonical implementation and independent oracle.
- Avelune document authoring profile
The restricted AsciiDoc profile, metadata contract, stable-ID rules, and validation expectations for Avelune documentation and specifications.
- Versioning and compatibility
The draft software-version and format-generation axes, intended stable-release policy, and required updates for format-breaking changes.
- Avelune web style
Editorial, visual, interaction, accessibility, and review principles for Avelune's public website.
- Release checklist
The pre-release checklist for documentation, validation, browser playback, generated artifacts, and draft-format review.
Project information
Status, contribution, support, security, and intellectual-property information.
- Project status
Implemented scope and known limitations.
- Contributing
Development workflow and review expectations.
- Support
Information to include when reporting problems.
- Security
Security posture and vulnerability reporting.
- IPR / prior-art notes — Draft Generation 1
An engineering risk register for prior-art neighborhoods and intellectual-property uncertainty in Draft Generation 1.
History
Superseded material kept for project history. These documents are not current implementation guidance.
- Historical internal Avelune “1.0.0” snapshot (superseded)
A historical, non-normative record of the internal Avelune POC snapshot that was once labeled 1.0 and is now superseded.
Historical