NixOS/nix

Move examples in classic commands closer to the top

Open

#10,717 建立於 2024年5月14日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)C++ (9,803 star) (1,293 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.