Skip to content

elaraproject/elara-handbook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Elara Handbook

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 handbook is actively developed and will not be complete for quite a while. Patience is appreciated!

About the Handbook

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.

Roadmap

  • 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