Files
reader/docs
hectorqinandClaude Opus 5.5 d8b3491e95 chore(web): remove the reading engine and helpers nothing runs
An import graph from main.tsx shows a previous reader still in the tree:
render/{reader,paged,pdf,text,container,theme}.ts with lib/{events,locator}.ts,
ui/settings.ts and bridge.ts — superseded by ReaderScreen/ReaderView and
never imported. Also unreachable: render/paginator.ts, render/window.ts and
ui/shelf-order.ts (only their own tests used them; the shelf sorts on the
server), formats/remote-zip.ts (re-exported, never called; chapters are
fetched per section), ui/source-capabilities.tsx and the sources pages barrel.

Inside live modules: PrefetchCache (only shouldPrefetch is used),
textToParagraphs / paragraphElement / endsAtParagraphBreak (the streaming
TXT reader's carry), txt.ts's textToHtml alias, and ChunkCursor. Their tests
go with them; the node:test list, the Vitest excludes and the docs that
named these files are updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-30 09:49:37 +00:00
..

文档中心 · Documentation

项目首页 · English overview

项目首页介绍阅读与影音能力;安装、日常使用、运维和开发步骤分别放在下面的指南中。 The project README introduces reader. Use the guides below for installation, everyday use, operations, and development.

使用与部署 · Using and deploying reader

内容 / Topic 简体中文 English
安装、首次登录、添加书籍、更新 / Installation and first steps 入门指南 Getting started
书架、阅读、朗读、来源和离线 / Shelves, reading, TTS, sources, offline 使用手册 Chinese only
电影、剧集、音乐与有声书 / Movies, series, music and audiobooks 影音手册 Chinese only
远端媒体目录 / Remote media directories OpenList 接入 Chinese only
安装到桌面、离线启动和版本更新 / PWA installation, offline startup and updates PWA 指南 Chinese only
环境变量、目录权限、HTTPS、排错 / Settings, permissions, HTTPS, troubleshooting 部署配置 Configuration
页面业务配置、服务连接与迁移 / Business settings, service connections and migration 业务配置 Chinese only
数据备份、校验与恢复 / Data backup, verification and restore 备份恢复 Chinese only
本地开发、验证、镜像与 Android 构建 / Development, checks, Docker and Android builds 开发指南 Development

技术参考 · Technical reference

以下参考文档目前以中文维护。The following reference documents are currently maintained in Chinese.

文档 / Document 内容 / Contents
架构与数据边界 / Architecture 数据目录、身份、同步和客户端架构 / Data boundaries, identity, sync, client architecture
前端 React 架构 Web 入口、Provider、路由、feature 边界和长生命周期资源
API 鉴权、书籍、资源、进度、文件管理、OPDS 与影音 / Auth, books, resources, progress, file management, OPDS and media
界面规范 / UI guidelines 布局、交互、可访问性 / Layout, interaction, accessibility

验证记录 · Review records

特定功能的验证产物写入被 Git 忽略的 artifacts/ 目录;当前结果以对应提交的测试和 CI 输出为准。 Feature review artifacts are written to the ignored artifacts/ directory. Use tests and CI for the current commit's results.

影音模块