跳转至

README 与 Skill 布局设计

目标

将 MinerU 代理指南设为仓库的主要 README,同时将其保留为可发现的 Skill,并在明确的语言文件名下保留现有英文和中文项目文档。

文件布局

README.md                         # canonical agent guide and former Skill content
README_en.md                      # former README.md
README_zh.md                      # former README_zh-CN.md
skills/mineru/SKILL.md            # symbolic link to ../../README.md

README.md 保持为普通文件,以便 GitHub、PyPI、源码归档和构建工具能够正常读取。Skill 路径是符号链接,因此 Skill 发现机制仍能找到所需的文件名和 frontmatter,而无需重复内容。

引用

  • 添加一条通用导航行,链接代理指南、英文文档和中文文档。
  • 将根 README 的语言链接更新为新文件名。
  • 更新指向已重命名的根中文 README 的仓库自有文档。
  • 保持嵌套的第三方或独立项目内部的引用不变。
  • 保持 pyproject.toml 配置为 readme = "README.md"。

验证

  • 确认 skills/mineru/SKILL.md 解析到根 README。
  • 通过符号链接运行 Skill 验证器。
  • 确认旧的根 README 文件名不再被仓库自有文档引用。
  • 在本地构建包元数据,并验证所配置的 README 可读。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 mi/MinerU