NixOS/nix

Move examples in classic commands closer to the top

Open

#10,717 opened on 2024年5月14日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)C++ (9,803 stars) (1,293 forks)batch import
documentationgood first issue

説明

Problem

Command line examples for classic commands are at the very bottom of each manual page, which makes them hard to discover after reams of generic options.

Proposal

Move them right after the description, as with the experimental commands.

Checklist

Priorities

Add :+1: to issues you find important.

コントリビューターガイド

技術スタック
なし
領域
documentation
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Familiarity with Nix manual source structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
Locate classic command manual pages in doc/manual/src/command ref/. Review the structure of experimental command pages to see the placement of examples. Move the examples section immediately after the description section in each classic command page. Verify consistency and that no references are broken.