NixOS/nix

List and document experimental features in one place

Open

#8,466 建立於 2023年6月7日

在 GitHub 查看
 (9 留言) (3 反應) (0 負責人)C++ (9,803 star) (1,293 fork)batch import
documentationgood first issue

描述

Problem

Currently experimental features are listed in the setting experimental-features, but documented in detail on a rather explanation-style page aimed at contributors.

Proposal

The second should not have that listing at all because it's unrelated, and the listing in the setting should contain the details.

Checklist

Priorities

Add :+1: to issues you find important.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with NixKnowledge of Nix's experimental featuresUnderstanding of Nix documentation structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Examine the current documentation: the experimental features are listed in the Nix manual under settings (experimental features) and also explained in a separate contributor page. The goal is to consolidate: remove the listing from the contributor page and enrich the settings documentation with details from the explanation page. Start by reading the existing files in doc/manual/src, particularly the settings documentation and the experimental features page. Look at the discussion in the issue comments for any specific suggestions. The deliverable is a PR that reorganizes these sections.