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

Rework documentation by following Diátaxis #50

Open
Zimmi48 opened this issue Jul 8, 2021 · 0 comments
Open

Rework documentation by following Diátaxis #50

Zimmi48 opened this issue Jul 8, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Zimmi48
Copy link
Member

Zimmi48 commented Jul 8, 2021

It feels like we are growing out of a README-based documentation. I think we could apply the principles advocated in the Diátaxis framework (https://diataxis.fr/): split documentation into tutorials, how-to guides, explanation and reference. Except that I would focus on how-to guides and reference to start with, explanations next, and tutorials maybe at some point later.

@Zimmi48 Zimmi48 added the documentation Improvements or additions to documentation label Jul 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant