NixOS / NixOS/nix.dev

Guides and Recipes overview

Open
#908 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

guide tracking
Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

This tracking issue is to keep an overview of guides for most common use cases.

Guides should complement the tutorials, and should be quite short. They can even duplicate important topics to have a condensed form for quick lookup. Related: https://github.com/NixOS/nix.dev/issues/910

A good example is the guide on sharing dependencies with shell.nix. It starts with a very small sample to show the pattern (which requires some proficiency with the Nix language to grasp quickly), and expands on the details below the fold.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing guide at guides/recipes/sharing-dependencies and compare its short, example-first structure with the checklist in this issue. Review linked issues 463, 490, 731, 907, and 910 to identify their intended guide scope. Done means the selected common-use-case guides are written and the checklist is updated.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.