-
-
Notifications
You must be signed in to change notification settings - Fork 232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Guide for writing guides #910
Labels
guide
Topics for a new guides
Comments
eflanagan0
added a commit
to eflanagan0/nix.dev
that referenced
this issue
May 9, 2024
Begin work of NixOS#910
eflanagan0
added a commit
to eflanagan0/nix.dev
that referenced
this issue
May 10, 2024
Begin work of NixOS#910
eflanagan0
added a commit
to eflanagan0/nix.dev
that referenced
this issue
May 14, 2024
Begin work of NixOS#910
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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/
The text was updated successfully, but these errors were encountered: