DOCUMENTATION
Start with the path that matches your work.
Guides for using Avelune, integrating its browser surface, and understanding the engineering around the Draft Generation 1 format.
Draft Generation 1 is experimental and unfrozen.
USE
Use Avelune
Start with the command-line tools for encoding, decoding, inspection, and verification.
- CLI guide
Encode, decode, inspect, verify, and maintain Avelune media from the command line.
guide
INTEGRATE
Integrate in a browser
Understand byte-range loading, the WebAssembly boundary, presentation, and optional acceleration.
- Browser streaming contract
The canonical WASM ABI, exact byte-range contract, cancellation generations, and bounded presentation model.
architecture - WebGPU and browser acceleration — Draft Generation 1
The optional WebGPU presentation and experimental codec-compute direction, including its hybrid CPU/WASM boundary and validation limits.
architecture
UNDERSTAND
Understand the system
Read non-normative architecture direction and the engineering decisions around the codec.
- Codec direction (non-normative)
The active, non-normative research direction for Avelune video, audio, and browser architecture.
architecture
CONTRIBUTE
Build and verify
Work with the conformance boundary, test strategy, version policy, publication system, and release process.
- Independent conformance oracle
Why Avelune keeps one independent decoder oracle and how its boundary is protected.
development-guide - Testing Avelune
Validation layers and regression policy for the canonical implementation and independent oracle.
development-guide - Avelune document authoring profile
The restricted AsciiDoc profile, metadata contract, stable-ID rules, and validation expectations for Avelune documentation and specifications.
development-guide - Versioning and compatibility
The draft software-version and format-generation axes, intended stable-release policy, and required updates for format-breaking changes.
development-guide - Avelune web style
The implemented visual language and QA rules for Avelune’s public website, technical publication pages, and browser demo.
development-guide - Release checklist
The pre-release checklist for documentation, validation, browser playback, generated artifacts, and draft-format review.
development-guide
PROJECT
Project information
Current scope, contribution, support, security, and intellectual-property context.
- Project status
Implemented scope, interpretation, and known limitations.
status - Contributing
Development workflow and review expectations.
contribute - Support
Where to ask questions and report problems.
support - Security
Security support and vulnerability reporting.
security - IPR / prior-art notes — Draft Generation 1
An engineering risk register for prior-art neighborhoods and intellectual-property uncertainty in Draft Generation 1.
supporting
HISTORY
Historical record
Superseded material retained for context; it is not a current compatibility or implementation target.
- 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 · non-normative