NixOS/nix

List and document experimental features in one place

Open

#8466 opened on Jun 7, 2023

View on GitHub
 (9 comments) (3 reactions) (0 assignees)C++ (9,803 stars) (1,293 forks)batch import
documentationgood first issue

Description

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with NixKnowledge of Nix's experimental featuresUnderstanding of Nix documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
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.