Skip to content

Use diataxis framework #388

Open
Open
@woile

Description

I've been thinking on some ideas to improve the website, before sending PR's I wanted to check here.

I feel like the current website is not beginner friendly, as a beginner myself, I struggle understanding many concepts, and how to read the reference documentation and how to use.

I would like to propose using the diataxis framework, which basically divides the documentation in 4 categories:

  1. Tutorials: must help a beginner achieve basic competence with a product
  2. Guides (present): can be thought of as recipes, directions that guide the reader through the steps to achieve a specific end
  3. Explanation: Explanation clarifies, deepens and broadens the reader’s understanding of a subject
  4. Reference (present): describe, as succinctly as possible, and in an orderly way

I propose adding a set of very simple tutorials, but including baby steps (which commands to run, what code to write, and where to go next).

  1. Packaging
  2. Development shell

I propose removing "Mixed documentation", and sending the articles to one of the corresponding categories.

Rename "Getting Things" to "Cheatsheet".

I was thinking of adding some guides to use flake-parts with home-manager and nix-darwin (I will need a lot of feedback haha), but I found @srid 's amazing nixos-flake.

What do you think of these changes? Would they be welcome?

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions