Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Guide for writing guides #910

Open
fricklerhandwerk opened this issue Feb 7, 2024 · 0 comments
Open

Guide for writing guides #910

fricklerhandwerk opened this issue Feb 7, 2024 · 0 comments
Labels
guide Topics for a new guides

Comments

@fricklerhandwerk
Copy link
Collaborator

fricklerhandwerk commented Feb 7, 2024 •
edited

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/
@fricklerhandwerk fricklerhandwerk added the guide Topics for a new guides label Feb 7, 2024
@fricklerhandwerk fricklerhandwerk mentioned this issue Feb 7, 2024
Open
10 tasks
eflanagan0 added a commit to eflanagan0/nix.dev that referenced this issue May 9, 2024
@eflanagan0
begin guide on how-to guides
0ce49da 
Begin work of NixOS#910
@eflanagan0 eflanagan0 mentioned this issue May 9, 2024
Closed
eflanagan0 added a commit to eflanagan0/nix.dev that referenced this issue May 10, 2024
@eflanagan0
begin guide on how-to guides
404f096 
Begin work of NixOS#910
eflanagan0 added a commit to eflanagan0/nix.dev that referenced this issue May 14, 2024
@eflanagan0
begin guide on how-to guides
a8d5b67 
Begin work of NixOS#910
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
guide Topics for a new guides
Projects
Nix documentation
Status: No status
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fricklerhandwerk