versioned guides - Githubissues

NixOS / nix.dev

Official documentation for getting things done with Nix.

https://nix.dev

Creative Commons Attribution Share Alike 4.0 International

2.32k stars 238 forks source link

versioned guides #289

Open fricklerhandwerk opened 2 years ago

fricklerhandwerk commented 2 years ago

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
- this is not true: https://github.com/NixOS/nixos-homepage/issues/237#issuecomment-417472733
considerations:
- maintenance overhead
- correctness and discoverability
- examples:
- home-manager
- counter-examples:
- NixOS Wiki
- nix-darwin

olafklingt commented 2 years ago

If the current documentation is merged into one repository, should this be considered the documentation of the current version? This could also help to deal with the question if one priorities new strategies in the upcoming versions. https://github.com/NixOS/nix.dev/issues/281

fricklerhandwerk commented 2 years ago

If the current documentation is merged into one repository...

To clarify: not all of the documentation is supposed to be merged. Only the guides to learn one's way into the ecosystem should be in a central place and help to discover the rest. Proper documentation should ideally be in the source tree anyway.

Reworded the issue description not to use "documentation" to loosely.