Documentation index
Start here:
Read quickstart for the profile-first workflow.
Read project layout for shared vs profile-local state.
Read profiles for the isolation model.
Read commands for CLI usage.
Read context before working on translations.
Read series for repeated next-book setup.
Read agent workflow for coding-agent operating rules.
Initialize a source project.
Extract source chunks into
.booktx/chunks/.Create or select a translation profile.
Build or approve
translations/<profile>/context.jsonandcontext.md.Translate via
translations/<profile>/ingest/.Validate the selected profile.
Build the final document into
translations/<profile>/output/.
- Quickstart
- Project layout
- Profiles
- Why profiles exist
- Commands
- Resolution rules
- Access modes
- What is isolated?
- What is shared?
- When to create a new profile?
- Pass-through profiles
- Selection profiles
- Single-source judge revision profiles
- What stays a version?
- Migration from legacy layout
- Failure modes
- Quality review configuration
- Series continuation profiles
- Concepts
- Commands
- Source-first setup
- Profile commands
- Generated AGENTS.md files
- Context commands
- Series setup commands
- Chapter detection and audit
- Status and identity
- Translation workflow
- Bounded agent runs
- Version commands
- Validate and build
- QA scan and EPUB inspection
- Translation preference dictionary / termbase
check– scoped build-preflight validation- Pass-through validation
- JSON output for machine consumers
- Context question lifecycle
- Review commands (
booktx review) - Judge commands (
booktx judge) - Glossary repair and chapter note reset
- Series context packs
- Terminology search and correction blocks
- Context
- Rules
- Source of truth and organization doctor
- Same-book multi-profile context sync
- Source-analysis review queue
- Typical workflow
- Context question lifecycle
- Glossary commands
- Chapter note commands
- Binding, advisory, and disabled glossary entries
- Glossary phrase collisions
- Starting the next book in a series
- Series workflows
- Agent workflow
- 1. Choose the access mode
- 2. Read the profile-local context
- 3. Request a task
- 4. Fill the durable ingest file
- 5. Submit the result
- 6. Validate and build
- 6b. Refresh editor QA indexes
- 7. Longer bounded runs
- Guardrails
- Finish a single large chapter
- Context approval hard stop
- EPUB inline XHTML translation rule
- 7b. Quality review pass workflow
- Judge / selection workflow
- Isolated judge workflow
- Translation contract
- Markdown handling
- EPUB handling
- Architecture
- Canonical Store v3 Split Plan
- API reference
- Development
- mypy per-code baseline (Phase 0)
- Troubleshooting
multiple translation profiles existno translation profile existstask profile mismatchsubmission profile mismatchoutput filename ... does not match target language ...legacy path used after migration- Stale translation task version
context_render_driftseries_prepare_pack_source_conflict/series_prepare_pack_source_missingseries_prepare_profile_conflictseries_prepare_chapter_audit_failedseries_prepare_isolated_mode- Source drift after extraction
- Validation warnings during bounded todo runs
- Latest todo is incomplete
- Todo planned chapters are already complete
- Task created outside a todo
- Context is not ready
- Missing source chunks
- Output filename mismatch
- Old
.booktx/ingestpath after migration TranslationTodois not fully defined- EPUB inline XHTML validation failures
- Validate passed but build failed (inline XHTML)
- TOC lists more chapters than chapter-map
- Bad hyphenation in a translated EPUB, for example
le-icht - Corrupted judge ingest file
- glossary_alignment_ambiguous
- Stale tasks after policy import
- Starting a next book safely