Skip to content

Commit 227083f

Browse files
committed
add slash commands doc
1 parent 51a8c84 commit 227083f

File tree

2 files changed

+201
-1
lines changed

2 files changed

+201
-1
lines changed

lib/algora_web/live/docs_live.ex

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ defmodule AlgoraWeb.DocsLive do
77
%{
88
title: "Overview",
99
links: [
10-
%{title: "Introduction", href: ~p"/docs"}
10+
%{title: "Introduction", href: ~p"/docs"},
11+
%{title: "Slash commands", href: ~p"/docs/commands"}
1112
]
1213
},
1314
%{

priv/content/docs/commands.md

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
---
2+
title: Slash commands reference
3+
---
4+
5+
# Slash commands reference
6+
7+
<div class="scrollbar-thin w-full max-w-2xl overflow-auto lg:max-w-5xl">
8+
<table class="caption-bottom w-full text-sm">
9+
<thead class="[&amp;_tr]:border-b">
10+
<tr class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800">
11+
<th class="h-12 px-4 text-left align-middle font-medium text-gray-500 dark:text-gray-400 [&amp;:has([role=checkbox])]:pr-0">
12+
Command
13+
</th>
14+
<th class="h-12 px-4 text-left align-middle font-medium text-gray-500 dark:text-gray-400 [&amp;:has([role=checkbox])]:pr-0">
15+
Description
16+
</th>
17+
<th class="h-12 px-4 text-left align-middle font-medium text-gray-500 dark:text-gray-400 [&amp;:has([role=checkbox])]:pr-0">
18+
Where
19+
</th>
20+
</tr>
21+
</thead>
22+
<tbody class="[&amp;_tr:last-child]:border-0">
23+
<tr
24+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
25+
data-state="false"
26+
>
27+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
28+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
29+
/bounty $500
30+
</div>
31+
</td>
32+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
33+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
34+
Create a $500.00 bounty
35+
</div>
36+
</td>
37+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
38+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
39+
Issue/PR comment
40+
</div>
41+
</td>
42+
</tr>
43+
<tr
44+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
45+
data-state="false"
46+
>
47+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
48+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
49+
/bounty
50+
</div>
51+
</td>
52+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
53+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
54+
Create a biddable bounty
55+
</div>
56+
</td>
57+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
58+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
59+
Issue/PR comment
60+
</div>
61+
</td>
62+
</tr>
63+
<tr
64+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
65+
data-state="false"
66+
>
67+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
68+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
69+
/content $1000
70+
</div>
71+
</td>
72+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
73+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
74+
Create a $1,000.00 video bounty
75+
</div>
76+
</td>
77+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
78+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
79+
Issue/PR comment
80+
</div>
81+
</td>
82+
</tr>
83+
<tr
84+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
85+
data-state="false"
86+
>
87+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
88+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
89+
/tip $100
90+
</div>
91+
</td>
92+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
93+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
94+
Tip the author $100.00
95+
</div>
96+
</td>
97+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
98+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
99+
Issue/PR comment
100+
</div>
101+
</td>
102+
</tr>
103+
<tr
104+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
105+
data-state="false"
106+
>
107+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
108+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
109+
/tip $100 @jsmith
110+
</div>
111+
</td>
112+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
113+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
114+
Tip the Github user with jsmith handle $100.00
115+
</div>
116+
</td>
117+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
118+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
119+
Issue/PR comment
120+
</div>
121+
</td>
122+
</tr>
123+
<tr
124+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
125+
data-state="false"
126+
>
127+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
128+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
129+
/approve
130+
</div>
131+
</td>
132+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
133+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
134+
Mark claim as ready to pay (in order to reward all such claims in bulk later)
135+
</div>
136+
</td>
137+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
138+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">PR comment</div>
139+
</td>
140+
</tr>
141+
<tr
142+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
143+
data-state="false"
144+
>
145+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
146+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
147+
/attempt #137
148+
</div>
149+
</td>
150+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
151+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
152+
Declare that you started working on the issue #137
153+
</div>
154+
</td>
155+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
156+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
157+
Issue comment
158+
</div>
159+
</td>
160+
</tr>
161+
<tr
162+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
163+
data-state="false"
164+
>
165+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
166+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
167+
/claim #137
168+
</div>
169+
</td>
170+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
171+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
172+
Submit an individual claim for the bounty of the issue #137
173+
</div>
174+
</td>
175+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
176+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">PR body</div>
177+
</td>
178+
</tr>
179+
<tr
180+
class="border-b transition-colors hover:bg-gray-100/50 data-[state=selected]:bg-gray-100 dark:hover:bg-white/[2.5%] dark:data-[state=selected]:bg-gray-800"
181+
data-state="false"
182+
>
183+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
184+
<div class="whitespace-nowrap font-mono text-sm font-semibold leading-6 text-emerald-300">
185+
/claim #137 <br />/split @jsmith <br />/split @jdoe
186+
</div>
187+
</td>
188+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
189+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">
190+
Submit a joint claim for the bounty of the issue #137<br />In this example, the award would be split evenly into 3
191+
</div>
192+
</td>
193+
<td class="p-4 align-middle [&amp;:has([role=checkbox])]:pr-0">
194+
<div class="whitespace-nowrap font-mono text-sm font-normal text-gray-300">PR body</div>
195+
</td>
196+
</tr>
197+
</tbody>
198+
</table>
199+
</div>

0 commit comments

Comments
 (0)