void-linux / void-linux/void-docs

Use bolding only for warnings?

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

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

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

説明

As discussed at #297 (e.g. this comment by @ericonr), i think it would be good to draw readers' attention to warnings via bolding. However, to ensure a consistent meaning for bolding, i think it should perhaps only be used in such cases, rather than to e.g. introduce terms, as in #177, where emphasis via *term* could be used instead.

(However, i don't think this issue should be considered a blocker for #177.)

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

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

はじめの一歩

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

調査の方向性

まず issue #297、@ericonr によるリンク先のコメント、issue #177 を確認し、ドキュメントにおける太字と強調の提案された意味を理解します。影響を受けるドキュメントの使用箇所を特定し、警告のみを出す一貫した方針に合意したうえで、対象範囲が確定したら関連する Markdown の内容を更新します。

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

評価

技術スタック
markdown
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

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

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