nix.dev

nix.dev copied to clipboard

We have a guide for writing tutorials: https://nix.dev/contributing/documentation/writing-a-tutorial

But guides address a different need: looking up contextualised facts to execute common tasks or implement common workflows. That requires a particular structure and writing style, which is usually much more condensed and can leave out many details.

Related discussion on how to structure guides: https://discourse.nixos.org/t/2023-05-04-documentation-team-meeting-notes-45/27874#what-to-do-with-all-the-guides-2

More: https://diataxis.fr/how-to-guides/