Add: Overlays concept / tutorial - introduction to overlays
Open
Nobody has claimed this yet.
guide (2)
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Learning goals
-
Understand overlays concept
-
What is the problem
-
How do overlays solve it
-
How to use them -> override pkgs within the fixed point
Prerequisites
- Understand a package set
- Understand a fixed point
Outline
Prior art
- https://discourse.nixos.org/t/what-are-overlays/14680
- https://wiki.nixos.org/wiki/Overlays
- https://nixcademy.com/posts/mastering-nixpkgs-overlays-techniques-and-best-practice/
Willing to help?
Yes
Priorities
Add 👍 to issues you find important.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the linked Discourse thread, wiki page, and Nixcademy article first, along with the prerequisites on package sets and fixed points. Create an introduction to overlays that explains the problem, the concept, and how to override packages within the fixed point; completion should cover all listed learning goals in a coherent tutorial.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100