Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Guide for writing guides #910

Copy link
Copy link
@fricklerhandwerk

Description

@fricklerhandwerk
Issue body actions

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/

hugosenari and eflanagan0

Metadata

Metadata

Assignees

No one assigned

    Labels

    guideTopics for a new guidesTopics for a new guides

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.