You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Within the team, we discussed the diataxis systematic approach to documentation, and we agreed that the distinctions it makes between "tutorials", "how to guides", "reference", and "explanation" are sensible and useful.
We want to restructure the docs to better reflect this approach. This doesn't necessarily mean having the above 4 sections explicitly. But for example, we could start by rewriting the current "getting started" and "example" in a way that there is a clear split between:
an entry-level "quickstart"/"walkthrough" tutorial that familiarises users to the basics of movement, via learning-by-doing.
"how-to-guides" for specific real-world tasks, such as "loading data from SLEAP".
The content you are editing has changed. Please copy your edits and refresh the page.
Within the team, we discussed the diataxis systematic approach to documentation, and we agreed that the distinctions it makes between "tutorials", "how to guides", "reference", and "explanation" are sensible and useful.
We want to restructure the docs to better reflect this approach. This doesn't necessarily mean having the above 4 sections explicitly. But for example, we could start by rewriting the current "getting started" and "example" in a way that there is a clear split between:
Tasks
movement
workflow #284The text was updated successfully, but these errors were encountered: