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.

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

Use diataxis framework #388

Open
woile opened this issue Jun 24, 2023 · 2 comments
Open

Use diataxis framework #388

woile opened this issue Jun 24, 2023 · 2 comments

Comments

@woile
Copy link
Contributor

woile commented Jun 24, 2023

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?

@roberth
Copy link
Member

roberth commented Jun 25, 2023

💯 I've already decided to take this direction, which is why Mixed documentation exists; that's stuff that I couldn't fit into one of the proper categories yet.

@woile
Copy link
Contributor Author

woile commented Jun 26, 2023

Awesome! I'll start sending some PRs this week

bors bot added a commit that referenced this issue Jul 3, 2023
404: docs: update structure r=roberth a=woile

related #388 

Co-authored-by: Santiago Fraire <[email protected]>
Co-authored-by: Robert Hensing <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants