Skip to content

Fix broken Diataxis links #664

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

Merged
merged 1 commit into from
Jul 27, 2023
Merged

Fix broken Diataxis links #664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions source/contributing/writing-a-tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

This is a guide to writing tutorials about Nix.

By [tutorials](https://diataxis.fr/tutorials/) we mean *lessons* as described in the [Diátaxis framework for technical documentation](https://diataxis.fr), and recommend becoming familiar with Diátaxis before proceeding.
Especially note [the difference between tutorials and guides](https://diataxis.fr/tutorials-how-to/).
By [tutorials][diataxis_tutorials] we mean *lessons* as described in the [Diátaxis framework for technical documentation][diataxis], and recommend becoming familiar with Diátaxis before proceeding.
Especially note [the difference between tutorials and guides][diataxis_tut_vs_howto].

We strongly recommend the book [How Learning Works (summary)](https://www.lesswrong.com/posts/mAdMkFqWzbJRB544m/book-review-how-learning-works) as a guide for designing learning materials.
We strongly recommend the book [How Learning Works (summary)][how_learning_works] as a guide for designing learning materials.

[diataxis]: https://diataxis.fr/
[diataxis_tutorials]: https://diataxis.fr/tutorials.html
[diataxis_tut_vs_howto]: https://diataxis.fr/tutorials-how-to.html
[how_learning_works]: https://www.lesswrong.com/posts/mAdMkFqWzbJRB544m/book-review-how-learning-works

## Target audience

Expand Down