Put "Best practices" parts where they belong
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
diataxis.fr describes how-to guides as:
- Practical steps
- That serve our work in Nix (rather than our study of Nix)
- That are task-oriented
The "Best practices" section on nix.dev does not contain guides. They are neither a series of steps nor task-oriented.
Approaches
The best practices section should probably be included with the reference material, possibly merged into the relevant descriptions of the language features in the Nix manual (for URL syntax, rec {}, with, <lookup paths>, the // merge operator, and reproducible paths) or the Nixpkgs manual (for "Reproducible Nixpkgs configuration").
Willing to help?
Sure, as long as I can just move the documentation around. I don't want to submit a PR and then get told to rewrite the docs to make them better.
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
Start by reviewing the existing "Best practices" section and the referenced Nix and Nixpkgs manual material for URL syntax, rec, with, lookup paths, the // merge operator, reproducible paths, and reproducible Nixpkgs configuration. Done means relocating these sections to the appropriate reference material without rewriting their content, subject to agreement on the proposed destinations.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100