obsidian-tasks icon indicating copy to clipboard operation
obsidian-tasks copied to clipboard

Add documentation for Tasks Commands

Open claremacrae opened this issue 2 years ago • 4 comments

These are the current commands:

image

Suggest they get documented close to where #754 docs go.

claremacrae avatar Jun 11 '22 22:06 claremacrae

The "Create or Edit Task" page seems to do a great job with covering the first command.

The second command is currently mentioned on the "Getting Started" page. Looks like the content needs a slight update, but to me this feels like a reasonable place for it. Do you think that is sufficient, or do you want to be able to have a single link that goes to both commands?

AnnaKornfeldSimpson avatar Aug 15 '22 15:08 AnnaKornfeldSimpson

The "Create or Edit Task" page seems to do a great job with covering the first command.

Interesting. I see that page as documenting the modal, and not the command.

I see the command as the thing that launches the modal, which is a different thing than the modal itself.

The second command is currently mentioned on the "Getting Started" page. Looks like the content needs a slight update, but to me this feels like a reasonable place for it. Do you think that is sufficient, or do you want to be able to have a single link that goes to both commands?

it’s fine for a page that lists all the commands to mainly link to details docs elsewhere.

Also, the commands are mentioned in many places throughout the docs, and it would be nice for them to link to the docs on the command. This would like make our spelling of the commands be consistent through the docs. I don’t think it is at the moment.

claremacrae avatar Aug 15 '22 21:08 claremacrae

All good points! ~~I might attempt to draft something for this one sometime this week then, when/if I have time.~~ Edit: Sadly, I did not have time and will not have time to get to this, so I hope someone else can help.

AnnaKornfeldSimpson avatar Aug 16 '22 00:08 AnnaKornfeldSimpson

When writing these docs, be sure to mention the auto-adding of global filter being added in #2015.

claremacrae avatar Jun 03 '23 22:06 claremacrae