Documentation ordering

[aubreyz]

Please check that this issue hasn't been reported before.

• [X] I searched previous Bug Reports didn't find any similar reports.

Expected Behavior

Reading the documentation in a sequential order needs to be more ... sequential. As an aside, there probably needs to be a separate issue category for documentation, if Doc issues are intended to be entered as issues. For now I used the bug category:

Background: I decided to read the documentation systematically from scratch as if I had never used tasks before. I think some people do that with reasonably complex software. I must admit I found the ordering a bit jarring.

• You start in "Getting Started" which has two separate Tables of Contents, one at the top and another at the bottom. The Bottom TOC is partially unrelated to the Top TOC, some bits refer to stuff outside of the getting started section, and the material in the Getting started section really isn't novice material at all.

• The ordering really needs tweaking as well - Someone reading the getting started section is going to get launched, as almost the first thing they read, onto Custom Statuses in Getting started on the left menu -- which is almost the most complex area of the plugin.

• Some of the items in the How Tos really should be elsewhere. I'd have thought the How to should really be reserved for odd single (per page) topics and hints that don't fit easily anywhere else. Two of the sections in How To are about statuses -- which should go with Statuses (and then more status stuff appears under References). Most of the things under Advanced could just as easily go in the How Tos. Some things in advanced (Quickadd and Reminders) should logically appear under other Plugins (which at the moment just has Dataview).

• Some of the stuff that a person "Getting Started" needs to know is not in the getting started section at all, for example the entire Query section would be missed if all they read was getting started - and all they would have read is one single Query example, so would not be able to start anything at all.

• Pages should not have a TOC at the top (for that page) and then a separate thing also called a TOC at the bottom, which is something very different, and which bears no relation to the side TOC.

Current behaviour

As above

Steps to reproduce

Reading it

Which Operating Systems are you using?

• [ ] Android
• [ ] iPhone/iPad
• [ ] Linux
• [ ] macOS
• [X] Windows

Obsidian Version

Not relevant

Tasks Plugin Version

Not relevant

Checks

• [X] I have tried it with all other plugins disabled and the error still occurs

Possible solution

I know the above isn't very constructive, So the below is a constructive suggestion as to structure. I am happy to help

========

I suggest: After the installation section what is needed is the following and everything can fit within that structure:

A) Getting started : This should be a genuine getting started - someone reading through it should be started. They should be able to write simple tasks, have read about most simple queries, and should not have read anything about Statuses, using filenames as dates, or a lot of the other stuff there.

B) Advanced: And under that B1) Statuses (everything about Statuses here - not in four different places) B2) More Advanced Queries B3) Autosuggest

C) How Tos and advanced

• Use filename in date
• Find tasks for coming 7 days
• Find tasks with invalid data
• How to get tasks in current file
• How to style backlinks
• Show tasks in a calendar
• Daily Agenda
• Styling (Urgency should go with advanced queries)

D) Other Plugins

• Notifications
• Quickadd
• Dataview

E) Quick reference