LumiRSS Documentation
LumiRSS 是一个邀请制多账户、自托管、source-first 的信息阅读器:运营者 经管理界面邀请成员,每个账号的订阅 / 阅读状态 / 资料库 / AI / 设置 / FreshRSS 绑定完全独立;FreshRSS 作为 RSS 域引擎与真源,RSSHub 生成非 RSS 来源,项目自有的 FastAPI BFF 与 React Web / PWA 客户端。
项目阶段:MVP(0000–0020)+ Phase 2 知识工作台 + recovery 返工均已 合入 main 并部署生产(2026-09)。当前方向见 ROADMAP.md;已完成工作见 history/milestones.md;recovery 账本(已冻结) 见 audits/phase2-recovery.md。
首次接触本项目:先读根目录 README,再按 getting-started.md 跑起来。
我要做什么 → 读什么
| 你要做什么 | 读什么 |
|---|---|
| 本地跑起来 / 自托管快速上手 | getting-started.md |
| 部署 / 升级 / 回滚 / 运维 | how-to/deploy.md |
| 邀请朋友加入(运营者) | how-to/invite-members.md |
| 备份 / 恢复 / 灾难恢复 | how-to/backup-restore.md |
| 排查故障 | how-to/troubleshoot.md |
| 查配置键含义 | reference/configuration.md |
| 查 FreshRSS 能力覆盖 / 委托边界 | reference/freshrss-coverage.md |
| 查上游全功能映射(FreshRSS/RSSHub 50 能力族 + 131 路由目录) | reference/upstream-feature-matrix.html(RSSHub 侧配套 reference/rsshub-coverage.md) |
| 跑测试 / CI 门禁 | reference/testing.md |
| 理解系统架构(数据流 / 边界 / 不变量) | explanation/architecture.md |
| 快速读懂项目(边界图 / 两条时序 / 追踪方法) | explanation/project-map.md |
| 搞懂全局搜索原理 | explanation/search.md |
| 复用 vs 自研边界 / 生成物规则 | explanation/reuse-policy.md |
| 关键架构决定(ADR) | 0001 · 0002 · 0003 · 0004 · 0005 · 0006 · 0007 · 0008 |
| 改 UI / 视觉与交互 | design/design-system.md(背景:design/README.md) |
| 产品范围与原则 | product/PRD.md |
| 许可证 / 上游引用 | LICENSE_AUDIT.md · UPSTREAMS.md |
| 查历史里程碑 / 发布记录 | history/milestones.md |
| 查冻结档案(recovery 账本 / 上游基线 / 阅读调研) | audits/phase2-recovery.md · upstream/SOURCE_MAP.md · design/reader-research.md |
| 查文档处置结论 / SSOT 归属 | doc-disposition.md |
阅读纪律
- 每个事实只在一个活跃文档维护,其他文档链接过去;
- 日常开发只读本文件 + 当前任务相关文档,不要预载历史里程碑、完整 PRD 或上游研究;
- 改数据路径 / API / 边界时读 explanation/architecture.md 与相关 ADR;改契约/生成物时读 explanation/reuse-policy.md。