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

Restructure docs informed by the diataxis framework #70

Closed
1 of 3 tasks
niksirbi opened this issue Oct 19, 2023 · 1 comment
Closed
1 of 3 tasks

Restructure docs informed by the diataxis framework #70

niksirbi opened this issue Oct 19, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@niksirbi
Copy link
Member

niksirbi commented Oct 19, 2023

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".

Tasks

Preview Give feedback
  1. documentation
    niksirbi
  2. documentation
    niksirbi sfmig
  3. documentation enhancement
@niksirbi niksirbi added enhancement New optional feature documentation Improvements or additions to documentation and removed enhancement New optional feature labels Oct 19, 2023
@niksirbi niksirbi moved this from 🤔 Triage to 📝 Todo in movement progress tracker Oct 19, 2023
@niksirbi niksirbi moved this from 📝 Todo to 🚧 In Progress in movement progress tracker Apr 25, 2024
@sfmig
Copy link
Contributor

sfmig commented Aug 27, 2024

We decide to close this meta issue because it feels too broad / a forever issue.

We will track this work with the individual issues instead.

@sfmig sfmig closed this as not planned Won't fix, can't repro, duplicate, stale Aug 27, 2024
@github-project-automation github-project-automation bot moved this from 🚧 In Progress to ✅ Done in movement progress tracker Aug 27, 2024
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

2 participants