Guide for writing guides
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
nix.dev/contributing/documentation/writing-a-tutorial にある既存のチュートリアル執筆ガイドから始め、次にリンク先の Documentation Team の議論と Diátaxis ガイドを読んでください。ガイド独自の構成と文体、およびチュートリアルとの違いを文書化してください。新しいガイダンスがドキュメントサイトで公開されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
We have a guide for writing tutorials: https://nix.dev/contributing/documentation/writing-a-tutorial
But guides address a different need: looking up contextualised facts to execute common tasks or implement common workflows. That requires a particular structure and writing style, which is usually much more condensed and can leave out many details.
Related discussion on how to structure guides: https://discourse.nixos.org/t/2023-05-04-documentation-team-meeting-notes-45/27874#what-to-do-with-all-the-guides-2
- 主要言語
- Nix
- スター
- 4k
- フォーク
- 343
- 平均マージ
- 1日 22時間
- マージ済み PR（30日）
- 10
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NixOS/nix.dev のほかの issue
-
site
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
NixOS/nix.dev#1224 · コメント 1 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
メンテナーはふだん 1 日以内に返信
-
FAQ (idea draft)オープンsite
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
メンテナーはふだん 1 日以内に返信
-
site
難易度 5/5 1週間以上 初心者へのやさしさ 38/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
bug: ARCHITECTURE.md states three different workflow counts (88 / 69 / 69) and no test pins themオープンarea:docs area:workflow bug documentation priority:later
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
Ikalus1988/MisakaNet#4357 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
aws-samples/sample-per-model-bedrock#708 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
voidzero-dev/void#677 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
ocaml-multicore/eio#962 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
microsoft/ML-For-Beginners#1061 ·