Zacess documentation

The Zacess reader: what each part of the core does and how it is checked.

These pages describe Zacess main at 2bc7be2, read from zacesshq/zacess on GitHub. Start with Install the reader.

  • Browser version

    The first usable slice of Zacess in a web browser, to be hosted at app.zacess.com.

  • Document model

    Every importer produces a Zacess document and every view and export reads one. It lives in crates/zacess-core/src/model.rs.

  • Import

    How a file becomes a document. The code lives in crates/zacess-core/src/import.

  • OCR

    How images and scanned pages become text and how a doubtful word, number or symbol is flagged.

  • Reading profiles

    A reading profile is how a person wants every document laid out. It lives in crates/zacess-core/src/profile.rs.

  • On-device transcription and live captions

    The core logic and data model for transcribing lecture audio on the device and showing live captions, with nothing uploaded.

  • Lecture recording store

    The storage core of recording a lecture on the device. The microphone, background modes and the screens are the app's.

  • Whiteboard and handwriting capture

    The core logic and data model for photographing whiteboards and handwritten notes, dropping repeats, keeping every version and turning each kept capture into

  • Universal capture

    How a web page, a piece of shared or copied text, an image or a file goes straight into the library's inbox.

  • Local library

    Where documents, notes, reading profiles, recordings, study decks and plans and captured clips live on the device.

  • Export

    How a document plus a reading profile becomes accessible output. The code lives in crates/zacess-core/src/export.

  • Braille-ready output

    How a document becomes a file a braille display or embosser can read. The code is in crates/zacess-core/src/export/braille.rs.

  • Maths and engineering mode

    How equations, subscripts, superscripts, circuit symbols and technical tables survive import and reach the reader as structure, speech and keyboard navigation.

  • Bilingual reading

    The original alongside its translation, with language switching that never loses the place.

  • Study sessions, revision paths and spaced repetition

    The core logic and data model for studying with Zacess: flashcards scheduled with FSRS, reading goals with progress, revision paths through a document

  • Ask questions of your own lectures

    Answers drawn only from the student's own material, each citing where it came from. The code is in crates/zacess-core/src/ask.

  • Helpers: diagram descriptions and "explain simply"

    Optional helpers that describe a diagram or explain a block more simply.

  • Lecture timeline

    The core of the lecture timeline: one lecture's recording, transcript, boards and pages, bookmarks and chapters on one clock.

  • Sync

    The local-first sync engine, built to agreed conflict rules before any server exists (sync arrives in v3 on the roadmap).