void-linux / void-linux/void-docs

Single-page version of Handbook?

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

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

enhancement help wanted
主要言語
CSS
スター
217
フォーク
212
平均マージ
2日 21時間
マージ済み PR(30日)
1

説明

Can/should we provide a single-page version of the Handbook? A user on IRC asked if there was one, and it seems to me that it would make it easier for users to search for particular terms within the Handbook.

Related: the above user noted that it was annoying to go to a page in the Handbook and find that it contained only a brief overview of the section. In a single-page version, i imagine this would be fine; but if we started adding ToCs for subsections (cf. https://github.com/void-linux/void-docs/pull/234), that might end up being unwieldy in a single-page version.

@ericonr, @bobertlo, thoughts?

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

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

はじめの一歩

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

調査の方向性

Handbook のソースと、PR #234 で議論されたサブセクションの目次アプローチを確認します。単一ページの Handbook が望ましいか、またそのナビゲーションでサブセクションの内容をどのように扱うべきかを決定します。実装前にスコープと出力形式について合意できていれば完了です。

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

評価

領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

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

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