Introduce notation and clarify prerequsites
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
Observations
Beginners seem to struggle with some basics that may be obvious to software developers but aren't to everyone else. One example is the diff notation: https://github.com/NixOS/nix.dev/issues/984
Problem
We're still not clear enough on what's actually required to make good use of the tutorials.
Approaches
-
Introduce notation explicitly, before first use or in an index (with links to relevant resources)
-
Note where appropriate that experience with Git is helpful (and link to useful materials)
Currently the tutorials have no actual Git interaction, but Git is everywhere.
Willing to help?
As always
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 tutorials and the linked diff-notation issue, #984, to identify where beginners first encounter notation or need Git context. Done means the relevant tutorial material introduces the notation and clearly states useful prerequisites, with links to appropriate resources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100