versioned guides
Open
Nobody has claimed this yet.
- Dominant language
- Nix
- Stars
- 4k
- Forks
- 339
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 7
Description
since the ecosystem is still changing significantly, it may be sensible to keep out-of-tree material in lockstep with major releases.
- related:
- NixOS/nix.dev#297
- https://github.com/NixOS/nixos-homepage/issues/25
- manuals are not accessible by version any more
- considerations:
- maintenance overhead
- correctness and discoverability
- examples:
- counter-examples:
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 related nix.dev and nixos-homepage issues, especially the discussion about version-accessible manuals, and compare the linked home-manager, NixOS Wiki, and nix-darwin examples. Done means reaching and documenting a clear decision about whether out-of-tree material should be versioned with major releases, including maintenance, correctness, and discoverability trade-offs.
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
- Needs clarification
- Newbie friendliness
- 25/100