nhcarrigan/docs
2
0
Fork 0
generated from nhcarrigan/template
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

feat: update documentation to reflect public task bot (#26)

Browse Source 
Reviewed-on: https://codeberg.org/nhcarrigan/docs/pulls/26
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
Naomi Carrigan 2024-10-02 08:11:29 +00:00 committed by Naomi the Technomancer
parent a2496b6e6e
commit 3028714212
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/content/docs/projects/task-bot.md
View File

@ -2,9 +2,9 @@
title: Task Bot
---
Task Bot (hereinafter the "Application") is a custom utility we developed for [Retro Island Gaming](https://retroisland.ny), but the source code is available for all to use as denoted in our software license.
Task Bot (hereinafter the "Application") is a user-installable Discord application which allows you to manage your tasks anywhere on Discord: in a server, in a DM with the bot, in DMs with your friends... The possibilities are endless.
We do NOT offer a public instance of this Application. Instead, please refer to Section 2 for instructions on setting up your own version.
Task management with this bot is an individual feature. If you need server-level task management, such as for a development team, please reach out to us in our support server to discuss pricing.
## 1. User Documentation
@ -16,6 +16,10 @@ Interaction with the Application is done through a series of slash commands ("Co
#### 1.1.1. `assign` Command
:::note
This command is only available on guild-level private instances.
:::
The `/assign` command allows you to assign a specific Discord user to a task. A task may have multiple assignees.
![A discord slash command named Assign, taking a task and assignee argument](/images/task-bot/assign.png)
@ -144,9 +148,10 @@ The `list` command allows you to view your tasks, optionally applying filters to
- `priority`: Only show tasks which are at this priority level. If omitted, will show all priorities.
- `tag`: Only show tasks whose tags include this tag. If omitted, will not restrict query by any tags.
- `assignee`: Only show tasks whose assignees include this user. If omitted, will not restrict query by any assignees.
- `completed`: Show either complete or incomplete tasks. If omitted, will show incomplete tasks.
**Guild-level private instances** will also be able to filter by `assignee`.
##### 1.1.5.3. Execution
The Application will construct your selected filters into a database query and use that to fetch the tasks.
@ -259,6 +264,10 @@ Otherwise, the bot will display an embed containing all of the information about
The Application does not perform any permission validation against users calling commands. All commands are available to all users.
:::
:::note
User-access permissions are only available on guild-level private instances. The user-level public application will only allow you to manage tasks you have created.
:::
If you need to restrict access to specific commands based on a user's permission levels, you can do so through Discord's native UI.
![Discord's command permissions screen, with the everyone role denied access, the Staff role granted access, and the complete command indicating it has overrides](/images/task-bot/command-permissions.png)