How it works
This shelf is for contributors who want to know how Bookclerk is built: the crates, the job queue, the storage limits, and how every plugin is confined. It assumes you can read Rust.
- Architecture: how the pieces fit.
- Discovery design: how suggestions are found and ranked.
- Embedding model benchmarks: how candidate models match taste across languages, and what they cost to run.
- Embedding model packs: how a model is stored on
disk, how the
embedderplugin runs it, and how it was checked. - Durable job queue: admission, leases and crash recovery.
- Bounded storage: size caps, streams, paged scans and checkpoints.
- The guest jail: why plugins run as jailed processes, and how each platform confines them.
- workerd bridge: the wire between the launcher and a plugin isolate.
- Node API and the live socket: how hosts of one library talk, and how the web app hears about changes.
- One TLS backend: the one crypto provider every TLS connection uses, and where it is set.
- Windows AppContainer: confinement notes for Windows.
- Rust crates: the reference for every workspace crate, from its doc comments (generated).
- Contribute: build, test and send a change.
- Design decisions: why things are the way they are.
Source: docs/internals/README.md at main · View as Markdown