OpenBook Learning Assistant
===========================

Under Construction
------------------

.. image:: under-construction.png
   :height: 15em
   :align: center

Hang on. This project is still in its early stages and under heavy development. This manual was set up
early to assist developers and others interested in joining the project by documenting our vision
and how much of it has already been built. Stay tuned until the first version is released, or better
yet, join us in shaping the future of education.

Welcome to OpenBook
-------------------

OpenBook is more than just a tool: it's a **personal learning companion** for students and a
**powerful teaching assistant** for educators. Designed by educators and students for students
and educators, it redefines how we learn, teach, and engage with knowledge.

For Learners
............

OpenBook acts as your **personal lecturer**, guiding you through your learning journey. It doesn't
just answer questions. It actively supports you by:

* Curating and organizing learning materials tailored to your needs.
* Monitoring your progress and suggesting interactive activities to help you meet your goals.
* Helping you prepare questions for your teachers and connect with fellow learners.

For Teachers & Lecturers
........................

One could say OpenBook is your traditional learning management system reimagined in the 21st century.
But OpenBook is much more than that. OpenBook serves as your always available **teaching assistant**,
But OpenBook is much more than that. OpenBook serves as your always-available **teaching assistant**,
supporting the entire teaching lifecycle:

* Structuring and presenting content - the core of OpenBook's functionality.
* supporting student self-studies,
* running interactive exercises,
* answering student questions,
* providing detailed progress reports,
* and much more.

Interactive Learning, Redefined
...............................

At the heart of OpenBook are **highly interactive online textbooks**, blending the best of traditional
print with modern multimedia. Courses built around these textbooks are enhanced by OpenBook's
**built-in learning model and AI assistant**, which doesn't just respond to prompts but drives the
entire learning experience.

Free, Open, and for Everyone
............................

OpenBook is **100% Free and Libre Software**. No exceptions, no excuses. We believe education -- and
the technology that powers it -- should be accessible to everyone, with no exceptions. There are no
premium versions or hidden paywalls. OpenBook is fully open-source, available for anyone to
download, install, and use **without restrictions**.

.. toctree::
   :maxdepth: 1
   :caption: Getting Started

   getting-started/teaching-and-learning-with-ai
   getting-started/design-decisions
   getting-started/community
   getting-started/code-of-conduct

.. toctree::
   :maxdepth: 1
   :caption: Students

   students/signup-and-account-management
   students/textbooks-and-courses
   students/learning-activities
   students/social-engagement

.. toctree::
   :maxdepth: 1
   :caption: Educators

   educators/working-on-textbooks
   educators/course-management
   educators/content-creation
   educators/running-courses

.. toctree::
   :maxdepth: 1
   :caption: Administrators

   administrators/changelog
   administrators/installation-guide
   administrators/basic-configuration
   administrators/auth-setup
   administrators/library-structure

.. toctree::
   :maxdepth: 1
   :caption: Developers

   developers/repository-layout
   developers/backend-architecture
   developers/frontend-architecture
   developers/development-process
   developers/local-development
   developers/versioning-and-releases
   developers/dependency-policy
   developers/ai-code-policy
   developers/ai-coding-tips
   developers/howto-guides
   developers/api-reference
   developers/repository-setup