User documentation sitemap

Every user-facing page, grouped by job. This is a list, not a second start page.

First visit: docs home or First analysis. Developers: DEV_INDEX.md.

Product and first run

Doc	Purpose
README.md	What it is, screenshots, first analysis, install
Website	Public landing (GitHub Pages)
docs home	Hosted docs start
PRODUCT.md	Product definition
Comparison	Is TranscriptX the right tool?
Comparison reference	Vendor-by-vendor notes
Known limitations	Optional stacks, AI, privacy
Terminology	Term index (includes auto-name / auto_identified)

Workflows

Doc	Purpose
Using TranscriptX	Outcome-led walkthrough index
First analysis	Import a sample → Balanced run → Overview
Identify and name speakers	Name diarized labels (optional Apply auto-identify)
Investigate with evidence	Question → transcript lines
Local AI synthesis	Optional Ollama summary / extracts
Export results	ZIP / HTML / EPUB
Explore Charts	Run-scoped charts
Bundle into a group	Several transcripts together
Correct while reading	Propose/apply in Transcript
Rename a transcript	Clearer library name
Browse speaker profiles	Longitudinal speaker pages
Assist naming with voice	Enrol-all / Pre-load assisted naming

Install and run

Doc	Purpose
Installation	Docker and ./transcriptx.sh
Installation details	Extras, profiles, env, gates
Docker	Compose-based runtime
Settings	GUI scopes, presets, knobs
LLM (Ollama)	Optional local AI
Models	Analysis model defaults
Workspace backup / restore	Full-workspace ZIP

Bring files

Doc	Purpose
Transcription	Bring a file, or generate a host STT command
Host STT automation	whispermlx-missing, inbox-watch, Python import
Auto-identify speakers	Auto-name / auto-link after ingest (Settings, inbox-watch, CLI)
Audio prep	Tools → Preprocessing / Auto-merge
Directory watcher	In-app inbox → import
WhisperX recipe	Optional WhisperX Docker
Whisper-WebUI recipe	Optional Gradio recipe

Read, correct, export

Doc	Purpose
Export	ZIP / HTML / EPUB packages
Corrections viewer	Propose/apply while reading
Corrections LLM	LLM discovery in Corrections Studio
Karaoke playback	Word-timed playback

Module notes

Doc	Purpose
Lexical diversity	lexical_diversity
Keyphrases	keyphrases
Epistemic markers	epistemic_markers
Politeness	politeness
Topic shift	topic_shift
Transcript quality	ASR confidence

Generated catalogs

Doc	Purpose
Module catalog	Analysis modules
CLI / Python API	Web launcher and typed API

Not listed here: contracts, storage rules, and programme notes — DEV_INDEX.md and CONTRACT_INDEX.md.