TextStack docs

TextStack is a library you carry with you. You add a book, read it on the web or on Android, save the words you do not know, and talk about a chapter with your AI assistant.

These pages are for people who run TextStack or change it. If you only want to read books, the app is at textstack.app.

Start with the stories

Eight short stories say how people use TextStack. No code, no technical names. Read them first: the words in them are the words of the whole project.

• The stories of TextStack
• The words of TextStack: one word for one thing, and the list of areas.

What do you want to do?

Run it locally Three short lessons, from a copy of the code to a book open on your screen.	Ship a first PR Three short lessons: pick the work, change and check, open the pull request.
Self-host It runs locally today. Production self-hosting is not packaged yet: what works, what is missing.	See how it works The parts of TextStack and how a book moves between them.

Look something up

• Settings: every environment variable.
• Connect an AI assistant.
• End-to-end tests: write and run them.
• The data and the rules for reading and writing it.
• Decisions: why each big choice was made. Read the status line of a decision first.

Where the project is now

TextStack is moving to V2: a new library and a new reading screen. Part of it is live, part is still switched off.

• The move to V2.
• What changed, week by week.
• Status: what is being worked on and what is known to be broken.

Rules for these docs

• A change to a command, a setting, a route or a setup step edits the page that states it, in the same pull request.
• One home for each fact.
• Plain words. The glossary has the word for each thing; use that word.
• Links are checked by CI: node scripts/check-doc-links.mjs.

The maintainer’s working notes are not part of these docs. They live in internal/ at the top of the repository.