aboutsummaryrefslogtreecommitdiffstats
path: root/todo.sr.ht/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'todo.sr.ht/index.md')
-rw-r--r--todo.sr.ht/index.md55
1 files changed, 54 insertions, 1 deletions
diff --git a/todo.sr.ht/index.md b/todo.sr.ht/index.md
index a923829..1582149 100644
--- a/todo.sr.ht/index.md
+++ b/todo.sr.ht/index.md
@@ -1 +1,54 @@
-TODO: write these docs
+[todo.sr.ht](https://todo.sr.ht/) is an issue tracker that can be used for
+your projects.
+
+# Getting started
+
+New trackers can be created on the [create page][create page] which can be
+accessed from the dashboard. Here you can give it a name and a description. You
+can also optionally configure your tracker by either clicking on "Create &
+configure" or by going to the settings tab at the top.
+
+[create page]: https://todo.sr.ht/tracker/create
+
+New tickets can be created using the form on the left. Existing tickets are
+shown on the right where you can optionally search using the search form at the
+top.
+
+# Search filters
+
+todo.sr.ht supports a few basic filters when searching for tickets. These
+include:
+
+- `status:open` or `status:closed`
+- `label`: an optional label that is assigned to a ticket for organizational
+ purposes
+- `order`: the order in which tickets are displayed. By default this is by
+ time of last update
+- `submitter`: the user who submitted the ticket. Use `me` to find tickets
+ submitted by yourself
+
+# Tickets
+
+Each ticket has its own page and number. On the ticket page, you can comment
+on the ticket (if you have commenting access). If you are the tracker owner or
+the ticket submitter, you can also mark the ticket as resolved as well.
+
+# Settings
+
+If you are the tracker owner, you can perform some customizations to your
+tracker.
+
+## Details
+
+Here you can edit the description for your tracker. At this time, the tracker
+name cannot be changed.
+
+## Access
+
+Here you can control access to the tracker. This allows you to set different
+access settings for anonymous users, logged in users, and ticket submitters.
+
+## Delete
+
+You can delete your tracker here. Be careful as all tickets submitted to the
+tracker are deleted as well.