blobs / docs

Build Blobs

Work on the native Android app or this documentation site.

Blobs uses Kotlin and Jetpack Compose for Android, Room and SQLite FTS5 for storage and retrieval, and a pinned llama.cpp CPU runtime for local inference. Python runs on the development computer for corpus preparation, not on users’ phones.

The 0.5.0 release built from this tree and passed the Android build, corpus tests, and documentation build before publication. The commands below reproduce that build on your own machine.

Build the Android app

Follow the Android build guide for the pinned toolchain, a clone without large corpus downloads, preparation, verification, and installation. App builds and unit tests do not need the reviewed record shards.

Use the contribution guide to choose checks for your change. Asset-dependent performance tools are separate from ordinary application verification.

Run this website

Use Node.js 24 and npm. From the repository root:

Start the documentation site
cd docs/web
npm ci
npm run dev

Open http://localhost:3000. The website uses Next.js, Fumadocs, local fonts, and MDX. Edit guides in content/docs; meta.json controls the sidebar order. Model and library tables read the Android app’s bundled package metadata.

The website guide covers checks, static export, preview, and GitHub Pages hosting at /blobs. Set NEXT_PUBLIC_BASE_PATH at build time for another subpath, or leave it unset for domain-root hosting.

See contributing for change ownership and review expectations.