[Nix-dev] Real documentation, aka "Let's kill the wiki"

[dieter at schoen.or.at]

hi all,
may i add that i rand into some pitfalls when learning nix/nixos when i used information from wikis and blogs.
as nixos is quite young and still in flux, most of the information is only appropriate to a certain range of nix versions.
for the case of the wiki, if it shall be kept, a simple method to avoid these pitfalls would be that it should be mandatory
to declare the version of nix/nixos when writing/modifying a wiki entry.
regards,
dieter
this is my first post here. 
i am quite new to nix/nixos and am fascinated by the concepts.
mostly, i am interested in bringing a machine up to a certain, well defined, state in a reproducible manner.
colleagues usually do this by hand-tuning a machine until it fits, and then clone, which always seemed awkward
to me. well.
Am Mo., Nov. 23, 2015 10:51 schrieb Anderson Torres :
Can we maintain the wiki as an unofficial documentation? For some
small hints and workarounds, it can be useful.

2015-11-21 18:21 GMT-02:00 Profpatsch :
On 15-11-19 05:17pm, Cillian de Róiste wrote:
2015-11-19 16:57 GMT+01:00 Profpatsch :
On 15-11-19 02:56am, Roger Qiu wrote:
May I humbly suggest http://stevelosh.com/blog/2013/09/teach-dont-tell/ (http://stevelosh.com/blog/2013/09/teach-dont-tell/) as
a general documentation writing template?

I'm a big fan of https://jacobian.org/writing/great-documentation/ (https://jacobian.org/writing/great-documentation/)

Yes, that’s what sjl references in the prior reading section as well.
These two are basically the technical writing 101 everyone should know.

--
Proudly written in Mutt with Vim on NixOS.
Q: Why is this email five sentences or less?
A: http://five.sentenc.es (http://five.sentenc.es)
May take up to five days to read your message. If it’s urgent, call me.
_______________________________________________
nix-dev mailing list
nix-dev at lists.science.uu.nl (mailto:nix-dev at lists.science.uu.nl)
http://lists.science.uu.nl/mailman/listinfo/nix-dev (http://lists.science.uu.nl/mailman/listinfo/nix-dev)
_______________________________________________
nix-dev mailing list
nix-dev at lists.science.uu.nl (mailto:nix-dev at lists.science.uu.nl)
http://lists.science.uu.nl/mailman/listinfo/nix-dev (http://lists.science.uu.nl/mailman/listinfo/nix-dev)
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.science.uu.nl/pipermail/nix-dev/attachments/20151123/e6f2b566/attachment.html