Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Create a ZIM with all versions of a given project

オープン
#42 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python

調査の方向性

CSV --slug パラメーターと ZIM 生成を処理する scraper のエントリーポイントから始め、次に issue で説明されている UI と検索の経路をたどってください。完了には、--oneSingleZim 形式のオプション、1 つの ZIM で複数の slug をサポートすること、UI でのバージョン切り替え、埋め込まれたプロジェクト間で機能する検索動作が必要です。

索引モデルが issue の本文から書いたものです。

説明

enhancement

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 はありません

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openzim/devdocs のほかの issue

openzim/devdocs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。