The Elara Handbook is Project Elara's open knowledge repository and documentation. Everything you'd ever need to learn, develop, or contribute to Project Elara can be found here!
The Elara Handbook is written in Markdown and Jupyter notebooks (with exception of the API docs, generated by Rust's native documentation generator) using JupyterBook.
We recommend Obsidian for editing the markdown source. Open the book/ directory in Obsidian as a vault of existing files, and then you can edit as usual.
The Elara Handbook is dual-licensed under the [Creative Commons CC0 1.0 Universal License](Creative Commons CC0 1.0 Universal) as well as The Unlicense as it contains both textual content and source code. Whichever is more permissive in a given jurisdiction will be regarded as the license to be applied across the whole work.
All issues will documented and put on https://github.com/elaraproject/elara-handbook.
- Finish basic setup and github pages integration with CI
- Knowledge library (mathematical fundamentals, physics, machine learning, Rust, etc.)
- Proper citations
- Narrative docs (tutorials, guides, etc.)
- API documentation
- Community resource docs (governance, design documents, contributing guidelines)
- Translations w/ weblate