Files
intl_news/docs/README.md
T
simon 3b44f64f66 refactor: 清理历史 AI Agent 文档残留 + 重构 docs/ + Pipeline 健壮性修复
- docs: 删除 CLAUDE.md / continuation.md / english-news-plan.md 及旧版 intlnews_usage.*,
        统一迁移到 docs/{README,architecture,quickstart,usage,pipeline,configuration,deployment,development,faq}.md
- README: 精简为仓库入口,指向 docs/
- configs/sources.yaml: 更新注释指向新文档
- .env.example: 修正 DashScope Embedding 端点说明

Pipeline 修复:
- dedup/llm/embedding/vectorstore/reporter: 过滤 M2 no_content / 空正文,避免污染下游与 Qdrant
- dedup/pipeline: 改为先写唯一文件再写指纹,避免崩溃导致文章永久丢失
- crawler/orchestrator: sources_crawled 改为“尝试数”,成功数 = crawled - failed
- crawler/storage: write_index_jsonl 从文章路径推断日期,修复跨天/测试路径问题
- scheduler/pipeline: STEP_TIMEOUTS 实际生效(SIGALRM)
- scheduler/reporter: emb_count 排除 index.json;日报跳过无原文事件
- vectorstore/pipeline: payload 增加 source_ids;--recreate --all 时空日期也重建 collection
- app/cli: extract/dedup/translate/embed/index/pipeline 支持 --date;embed/index 支持 --all;crawl 全源失败返回非零
- scripts: domestic_full/crawl_8g/crawl_2g/pipeline 安全加载 .env;M1 全失败不标记且最终退出码=1
2026-08-22 20:47:53 +08:00

28 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 文档中心
本项目 **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) | 常见问题与排查 |
## 顶层入口
- 项目根目录的 [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`