Create a ZIM with all versions of a given project
还没有人认领这个 Issue。
评估
调研方向
从处理 CSV --slug 参数和 ZIM 生成的 scraper 入口点开始，然后跟踪 issue 中描述的 UI 和搜索路径。完成这项工作需要一个类似 --oneSingleZim 的选项、支持在一个 ZIM 中使用多个 slug、在 UI 中切换版本，以及能够跨嵌入式项目工作的搜索行为。
由索引模型根据 Issue 内容生成。
描述
Currently, it is only possible to create one ZIM per slug. E.g. one for one for lua5.4, one for lua5.3, one for lua~5.2 and so on.
Analyzing a bit devdocs, it showed this means we will create 716 ZIMs, with new ZIMs coming at every release of projects (lua, ...).
This is way too much, and this is not really convenient for the end-user who typically know he needs documentation of a given programming language, but usually need documentation for multiple versions.
We would like the scraper to be able to embed all versions of a given project (e.g. lua) in a single ZIM. This obviously means significant changes to the codebase, both in terms of ZIM structure (to accommodate to multiple slugs in one ZIM) but also in terms of UI (to be able to switch from one slug to the next one).
It probably also means that something needs to be done to provide custom search capabilities directly in the UI: currently suggestions and full-text search are already hard to use, but it will become even harder if we have multiple slugs in one ZIM. Or maybe this means we need to enrich the search capabilities of the libzim (e.g. ask the libzim to search only in a subset of articles ...).
To make the feature as generic as possible, I think that we should continue to use the CSV --slug parameter to specify all slugs that we want to embed, and add a --oneSingleZim (or something like this, I'm bad at choosing names) parameter to indicate we want all slugs in a single ZIM file. With this approach, it means we have lot's of flexibilities, and we can for instance embed all Vue (Vue, VueRouter, Vuex, ...) in a single ZIM file even if they are distinct project son DevDocs side. Or we can even create a "all DevDocs" ZIM with all documentation.
- 主要语言
- Python
- 星标
- 9
- 派生
- 3
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
openzim/devdocs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 4/5 3-5 天 新手友好度 55/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 4/5 3-5 天 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 45/100
相似的 Issue
-
request-theme
难度 2/5 1 小时以内 新手友好度 70/100
LizardByte/ThemerrDB#8877 · 1 条评论 ·
维护者通常 1 天内回复
-
area/install-update comp/gateway P0 sweeper:risk-compatibility type/bug
难度 2/5 1 小时以内 新手友好度 72/100
NousResearch/hermes-agent#135997 · 3 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
deepset-ai/haystack#13199 ·
维护者通常 1 天内回复
-
[BUG] JSONLoader rejects valid UTF-8 BOM files可能已有人在做 @zouyonghe 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
anthropics/knowledge-work-plugins#1298 ·
维护者通常 1 天内回复