29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
# 文档中心
|
||
|
||
本项目 **English Financial News**（`en-news`）是一套面向国际财经新闻的私有化 Deep Research 平台：抓取、去重、翻译、事件抽取、向量化、语义检索、日报生成全部在本地/Pi 上独立运行。
|
||
|
||
> 本目录是项目文档的唯一入口。历史 AI Agent 文档（`CLAUDE.md`、`continuation.md`、`english-news-plan.md`、旧版 `docs/intlnews_usage.*`）已清理合并到以下文档中。
|
||
|
||
## 文档导航
|
||
|
||
| 文档 | 内容 |
|
||
|------|------|
|
||
| [架构说明](architecture.md) | 总体架构、模块职责、数据流、部署拓扑 |
|
||
| [快速开始](quickstart.md) | 环境准备、安装、配置、首次运行 |
|
||
| [使用手册](usage.md) | CLI 命令、Shell 脚本、MCP 服务、日报查看 |
|
||
| [流水线详解](pipeline.md) | M1→M9 各步骤输入/输出、增量逻辑、幂等机制 |
|
||
| [配置说明](configuration.md) | `system.yaml`、`sources.yaml`、Profile、`.env` |
|
||
| [部署与运维](deployment.md) | Pi 服务器部署、Xvfb/代理、crontab、日志清理 |
|
||
| [开发指南](development.md) | 源码结构、测试、已知问题、新增新闻源 |
|
||
| [FAQ](faq.md) | 常见问题与排查 |
|
||
| [Git 提交流程](git-workflow.md) | 已验证的 Gitea 提交与推送方式 |
|
||
|
||
## 顶层入口
|
||
|
||
- 项目根目录的 [README.md](../README.md) 仅保留简短的仓库入口和文档链接。
|
||
- 当前推荐的执行入口：
|
||
- 全流程：`bash scripts/domestic_full.sh`
|
||
- 仅 M2→M6+日报：`bash scripts/pipeline.sh`
|
||
- CLI 单步：`uv run en-news <command>`
|
||
- MCP：`uv run en-news mcp-server`
|