Documentation · 025.1
The product documentation is a folder of self-contained HTML pages that ships with the Lumina repository, with shared navigation, search, dark mode and print styles. Here is what it covers.
docs/ folder of the Lumina repository. It is not hosted on this website, so there are no links here. We share it with every pilot, and on request before a demo.Using Lumina
User guide: circulation
Check-out, check-in, renewals, holds, transfers, fines and the cash register.
User guide: cataloguing
Records, items, the MARC editor, import, labels and authorities.
User guide: patrons
Members, categories, cards, restrictions and privacy.
User guide: OPAC and patron account
The public catalogue and the member account.
User guide: acquisitions and serials
Vendors, funds, baskets, orders, invoices, serial prediction and claims.
User guide: reports and admin
Reports, the builder, preferences, notices, calendar and cron tasks.
Mobile apps
The staff app, the guard gate check and the member app.
Coming from Koha
Koha migration guide
The four sources, the wizard and CLI, entity-by-entity mapping, rollback, and what has and has not been verified.
Koha feature parity
All 188 Koha capabilities mapped to Lumina, with a status and a reason.
Koha database reference
How Koha's data model maps to Lumina's.
Notice, preference and circulation mapping
How Koha notices and preferences carry over.
Running and building
Architecture
The monorepo, the API modules, the web app and how they fit.
API reference
The REST surface of 723 endpoints.
Database schema
The 101 data models.
Deployment
Node and Cloudflare hosting options and what is verified.
Security and privacy
Authentication, roles, audit, privacy and the gaps.
Testing and quality
What is tested, how, and what is not.
Design system
Lumina Sapphire: tokens, typography and components.
Context
Product vision
What Lumina is for.
Competitor analysis
How other systems compare.
Standards and India
Standards, formats and Indian context.
Changelog
Release notes and known gaps.
Every page carries a "verified against code" date. If a page and the code ever disagree, the code is right.
Next step
Want to read the docs?
We will send the documentation folder with your demo confirmation.