From 6067c8d55e8fba57df866ba8a34c7aba8a4a8714 Mon Sep 17 00:00:00 2001 From: El Laggron Date: Mon, 17 Aug 2020 15:35:44 +0200 Subject: [PATCH] [Docs] Alias user guide (#3084) * Getting started guide * Remove DigitalOcean referral link * Fix typos and mispells, thanks to @Flame442 * Remove cogs.red hyperlink until it is finished * Add towncrier entry * Add prolog.txt This is not necessary for this PR but all of the other cog guides rely on this file. The cog guides are individual branches based on this one, which is why I'm adding this file right now. * Add changelog entry * Add alias cog guide * QA changes * More QA changes considering -> assuming red is a girl, not non-binary * Fix some mistakes * Fix references * More and better examples, with arguments * A first quick fix for review * An attempt to fix the review by @Flame442 * Delete 1734.docs.3.rst Co-authored-by: Toby Harradine Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> --- docs/.resources/alias/example-1.png | Bin 0 -> 14489 bytes docs/.resources/alias/example-2.png | Bin 0 -> 15248 bytes docs/cog_guides/alias.rst | 277 ++++++++++++++++++++++++++++ docs/index.rst | 1 + 4 files changed, 278 insertions(+) create mode 100644 docs/.resources/alias/example-1.png create mode 100644 docs/.resources/alias/example-2.png create mode 100644 docs/cog_guides/alias.rst diff --git a/docs/.resources/alias/example-1.png b/docs/.resources/alias/example-1.png new file mode 100644 index 0000000000000000000000000000000000000000..58b3bf1862b509417fab3077cb1fcfa6bb0631c4 GIT binary patch literal 14489 zcmdVBc~n#R_AiK~<#4ZxrB)#*P!teBKqVw1VNy{bj55m*CF-tFI8-K$@(?tc9T>yWc@&Ub(J zckj>s>>-bC+L#^rhulA;q@<3(&9B=_NqvQulG-D8a6fRz;==FW1D8GF_GZ_lsH`(H zz=wUPtJYVgq^fZL+_?QU@cGbPbJuVwsiUtYe|y?PN_>Eu$0Kgsif{-)Mnv5X^OZ6S z^Ysl5_X~;ebUFw;a`_ni`c=n!o+1+BNrcNl?V`+rWuDjK_xFDI_1CN4Joxo{yX%LK zzxnlhklHDgAFn-A`X=GfFZ-2L4#*|=U3qjiE_d>#wBfYwL>zcco>lu`!7GTC3nBu_y5$RnPBwRVymsvgV}~OuJP*Mga43vf9oRp;Pb-t zh$+6uKB>E!*^meC>@8r6;pe}Sx}522J>>OyUh%;@L%XqcI5BVQvyjBgnEy)Z%s)X# zlp?}-&H3b+8LM7@#=SjKDPQ9s9)mS3jM=i6B8vQ=zD-h6?O`ESL$-PGyajxI^wQ69 z;?JMcQKz-9SS;kiimKh>aq!sn$~nW5m1%B%Q`!2=1%t@dPb+y1 zO`mwDgL2Z_u!7`8d6yw8!r7pyzxPhU}4GM`-JvYyBj4 zS9Ck@_C*6GfbKGDIUhp_Pr)QF_s>LpjCPbCa5`P@;w5mvMg^(lZv~G~vQ=?8iy09% zb#0lDht!-T{q|*TvD2{ILD9dTborB8nd9-|+m^NFn zskw(Qm&AaWb-xvtoy@sYAzJCcI_|wyI1e?2YN(5QlS4m7SL`qJhs3|7L4%`aRo_-a zsSx+|K|OqR6W#RW>yNqSFvWuT#UVMkc0^F&u2l?`Z!8xnV37o?9H!5oOK0^LnETgq z-By0Bao9Nk6dNq7hVJ~WlWZPCdIUaUQCAM4fFe~LR1pIXcRKf#aR)gfgs1n=V@rEd zU}gT}SE6rY>sr-1&ksi(`jY`Yl@Xnro5;B~|B}L>(h4#~VjZrYw?o4b6RL09_pfiR z8!sCm4})I^)1h^TQ`!e?MX&}^n>DR;oJJv6c~Dp^d zCu$2BZeZH|d?PjKLntW}~OaHVk72U^5!!8M_qJZ&I zj|A62wf)`0n6RJ~Mo?kn!?eS$oKimA;`L2$gJpvuD~zc*qYiw*C{M^vE*JJ=HQF?p zi!eDCMnFYo!(4CE;@VRIG)*{0l2M&1sk}o(4)`HnAA~3_}KAC~6*>09mLF@(GNXqAIiUP_%(Ha@-^Lusv z8lmpr3PsWnxieHUIt_6eouz>)bEnJ)SIjN`1b=H`b!or7b(&zX_-a>o4J-uSE^Kr(p3c{kR>3`X2$`zN>UBLPRldX$( znwRYDIm5Bm$fSlkx!3I&&n8pSf+Bov6gwG;;ICnQoXvJY=S8Yd-SVlL=AjrL{~geE z1_k-pFRS72fwHZ_5=$(v$;_R_s5*+&B7!RXubjj&!FA_)yciRMEz2Z{tp-slDZ(TP2l}O;T9h&B>htyW(UqJjUt`CLIMA~>1gI=c2mn>`)8szObfZZTxXzEr& zPPJLE?&HuN1JeM^3BIIpp8)X0c)*{v@(3kr); zm}t~Tui_GeM}+3#?6rukyRvTyyOysmd)7EDefjg?VR#VA>)=y>4cz7C7Q!7~2pL+c zE_2uJ@qfU3fC>!8L}7vI_&`wWIn_QYuj+lYw19L!@qWevF ztF%b{rM`C4O=rY|hE5fA-xs-JZ7@0w$8B+FPS)(^RTmWw@1wuuL*F_JeG-e?_RJrfi3BrYoUlgZf77wW|%#qe9HpPrVNT)WxKr=^vv-@x<^5%&g@84SeKykv_t#J;$aK1U1LvkTqONh*c8kj zG5oRBGbeNHF3EqY#uH{F=fx0~mw!R$nCmk=&*c5zRcst~uixv^`s>A*e)TWjYR%A% zRsCAkK=q0`zK{W)@ud?-bbhw5a2&Gk4c)W~C&%f)i$WvZ+r#JM{-7RmwvR8E7sHtL zI{3^9HMDuS(-M^f}LTF)9dfd1@)U_c8gf_EoSHV)XjQPs~n(?Qb!(~Y_0J~(d z$Z*65xVl|`Jf--M-9iT#-l=lJshH|D^I`J=XP~~{1``BYic@+=#l={hA&k_$( zN2||I+9ag?bo^%4LH2`)PK3SwK=~uLR*gd`$CJoLzJGx2xc9)RQ^6LX_jZBoE;2mD z7*FvG@W|j_t_`B%;8p!?-$;^AA=oXSKSBAwHTHGgcmSf-D2k}DX)r>!}(B2Mq< z8hSnE@F1a73j;(aKFjCLLT{16zhY370EcZd&Kx8{B4}ywyY?bRZ?uNBn_R2Ymnd7V zzDrVLzPB2Rws>f%?=nOo8a`w#>X%2I`!57u;UGRTFYT{|=svwO1M?G>vW-+$X~r&Y z{l~jj&l$%S_dJ_fd@ytyzvNoIao=^NFyY((;kv69iqn-|&eIW9^M7qRd?AR=J6tOp zvUDZ8W-+rxsVpRDib||m$srVf!6Zu2wi!v16#N&v`}cDX-gW+`Xh6aOkny;4@V@Y1 zAb*iib3b)e(yE@!o}HAXCOwU{k^4kSD#cfQJIj*VI`DrjC42c|J;!PKB9P6EoXm#2 ze4!&heGwB8KfMH`Pg2D|*5?vYv{$|;WoMc95kIouKZcx+Uu}n8!M~ ztxGAJ1E3&n8+1QAFakLVTN@C@w`@$J6tK_o4Yn-Y`6Ju%0CbY0=!yMnI}2NI_uA;^ zdFOAw*^6D#$fw_*HydxbKWAH6A5;x($QG;J&}DOYKEv9k@* z{$rZxOE8@<`P=L|>!H^1%}t&psp8x$^!d=ZoW^LpM3SV#{5_x`JD)eO1mx&LJ4;$G zAys$~Ul+t?KQml>PTHXKg?A{S0@{r9=F`NHzts&cBLpVDsNC{YlGo zZzuruIWsr)E)A6LWG<2i^!Ls(N(zBP>%csK=j1>{dFZIXfCE-Iqad~b#aQ~p_NDbu zM3NLva=?)wgUzKr%2oVQ&`qqy(k+R?-!uYwT9()PvV+T%C3_C$DV&9(3yk8IKLlij zY>AuetSv-}TVpy|`CAJUiZdn?DQkacr%>9Sf6kMng1TFuR&X`7VWY6^6dSitU%z70w!=&6px2h$2_>aZ#o-E*mQx44VU6p|d=dj3b)AHC{0xyO_g39W{_5EC1+DpFpUQ~x(4rC63=9g!>f{|rs zCkha1@;L;^iXPa^nbIrKG6 zHr*eQQ$tvF^rFr0N?d|(scL9{Cd%l_F)l93N62gZTk$OMlfCXB-y(pIi9Te7c*q-H zA1!bez380gQU5frr3_D_v}mT`zwMr8i3JX_n6RZgkAjj%taEk<`8IkG?lO#Dg`Ngk zS7JAgIpHCKb{xWYZ23MY=vzFm*yAkjOsY|;Yl&e~Mr+Q&5u zWf!J17`^ti)jBsss7fAsDK_a5N*06 zGb7)OIGa|MEA!&z2R13Sl8jE`taWNpLGP{;ll`wRNHaYTe=Z^%!PW5R$iDdn#;;Sy zH7Q8eR6q^B$XoBB~l|Z1Q(<1vLtl0dKg(n9qjn)&SYef>qEAe`*hb@Jr zApwz7Rxy*QW=18^i{!x))9Y-iGwQxQ#w?KezN80oPZEinM zzLU5$YZ~Y6L|pkJgF<-UflYm#+QQxm3(;?#zw!#K4gVo#xp9jmasErlD>2=d{3XO} z^9c!vBxp#$ai5rh5t;*4v=;+k_Vwyp2|)i614PdMR%rYZR7tW|o4+8{cD3<;Dt5|w zq$2ksZ2$L>b|-BogGBM4SJWRIyS6v^-X>mJ`9ZL`#?Nq*gU@w(e?8y({R3)ohNOc0j^KAa%kS7V zZl8r_0Q>U-ZtMF8@0wj&E~IqqTO5yXPB;d;87)oO2Nc2|eCNDO|uR< zf1|5FdZ{*~(tBV0!iI)R=%zqy9A9D;O8xFaqx|e_nBO4et`Z zx+J4O-!A2j;&LKvW5>jw#|rLyok=}ZWO=1jQiW#f#()0E3m@N_;?=i&DrL4Ctv@=z z7Vgxf2WE!ya<0%z~y8<$4mxHcvuq;6Zucsq1@HWUQaX#5ZT`#NFCn~hAvKcko=u1Lbu!O znA_}NX{({H8UyglQ;J)0tE(4`KR+8Ew%C}S+J1%G>@)Py#x_+%;>urc9&gD52qn?E z&YI49=JEH$|HAdJ{-xUz!J+$;;C%-4MyE2D;W%JjPN{>ZG#G)9SLc3>kEH#`{_b5D zdGsL|{Ue*h4azSE7(mL_{G8!pYW4bEE$WYK@F3&f<|1XhMob2Z_-hF;*Vgi=qiH{P zL{Ia_%<{_kb)5DAax!@}X4Z{KWwqbfKCqxYx7qKk>ao;W1{pK&&92Lsd!h_})jzoi z5KDyWkV#})lX4jA5DWnMBbzY+M;vDx(VUBDY%?xlLBZ`1u<<|0&k4cn9)KELiZ7wZ zHyM2DaY|&T|Ef9o+-IxIxV#DP9tfI9_X;swSSqlgAeMiI3x(J-=_~Ina!GKeF1>zh zZH$MvHQsukbH|8kc1{K#lH4$+rc`Q+{mGR#Sm`Oe#jQ7TnTUB@oLL;VPLHY-tR?j6 z;OjE3e2bgPtrF;55jcdGiV?*Q6ndesB7@h+HN<)9R9bE>KQrPl_1k*I+zs|0KKJ$= z%|*bE9^jB?Bt>&x4kL|;hi>B5}uAVUqiGDVWn}L z@`csYr9!h-;pg6l1#OZ}a%D^~p0P|5Gw+%DdMb(u+$V8@6+`U^45av@Wh*Lr+XL{A z%y3YWkGMmJxjYT9^}7Qta;I}-;+M@2A?P;fk4x(c-VVbSL*l+qiKm!lkXvimIc3|q zywXiie37_;b*4H*6f@*F{5@x_zSfxp$!wp#GXq((a$7DO|F)dk+2pwt%erk#vI)-G zy3!jUf132VDbe{uptYMd!%3Moxo}=-rd#_2&s?q^E9)s2usek*R&Gc)S)vqUiaNOt}w+{FA7p z^i7skn>le^^HQ>C@lQZehkb&$>Rk0?cyZH|K4#PJJgrv1a;VFvc(v)A8*b!~XHS>O znl!hD+rXqpYl+*&h|KW6VIED!S&gQ(Sg3sTdBLZ&DUbDRIA8sUTbm2_PhPF`KzKBw zAec02<4w#ZfSNjD!z63Vw?@0xQVn5i8qVVk--Uqswj>d*fM$`3Owe zayI1cIrZS4SM;njPCq8ha507x`4zlHeHq{k_**f79=UIdjMsN~tFI8=Id z`XV;mxpy)x-Gz=lePaQJmBp@u9acQK{!sA#${x=I5N}sW;8NbaN%|u#TyeCWy(qFM z{S=}YbVC&ZwAozj^A)^|=`bDNBqOAQQ`CN~oUh+f$7#~4>lHb^1$vXz)Hn_%EEbNT zbu~Vz6#$Sq67$(~D1hDAQ1q9GW3h0?DX-o4_hwds(9S|9d+TmTte+~2L&m`S7`ks8 z|2Z)MRVvLJ(?o4rDEFz9O0SHIMlP!d~*^}tBRJ=|Q!rJIW5E)p04Kj79k%$4zK=wNEpbc4Nzziv(e)nUb} z2cPsHrPHd5bGgT%IZibTGarI@;%ekx+@!Ez5F`%qU3YbD-d|ymkI8K`N(4CVxQv<4 zFP#q}PJn{?&E(R96V2^kM39J+B+dH6H{{ZLFDpw_GI0yvls*sp8KpQtE>xEze5Ky) zKl*BM-rwIos%qQsl9Q0sTI;Zk$aasjIKEsIz0Nt$Tg;n~g!@5a&ERS3^{OXDtp1YDbx4(yIZbP+QNGc|197F{g__XsmP(6mq!Pb0&1f+ zdZW9b%n2uSbyyJAYE$sZit6qyp7;OWq2MxV>H^gAvyLy_^*-A#8O3h&Xo~Odyxh4j zMpM2LgW$Y1b{}^e69*-8(B<)#zEoX}9NBZ+(g~l#jVnR#mclvtJMqouTH_&nCjE4@ z!3javvzIp33r5sa8NZ|C#8rh!z3mIBC@5HLSDcPj`%bYZ4m=oT;eGSSV_eVF)Hd`` z`^FXUm%vX8Y83`LClp+!h6A+IDrb_kccAA|?CVUn%4DeGX;l?*`J0J1P$tcSls%HrF#Gvkws(=TSEqaMYFd>CSD2k;~?Q#m+oaBI{fd}aFB0K!r+pYqrA zNJ>i7!WyfsR4`?j7PW2~P%3odRx;=T=Lfpq`XbJ_ha#i3%EOv-+s80B2|{`M%rH`8 zimZv#<^lKOUB=|W?lSM5T*km<$zCIb{y4(34&nl?||-j~ZNUsGHD^WH5{9Hc6+KZu1AxUiEKyvyK*R zW@0f?^uTr49o^XsE9NQP>2jyTk>U?55E$(dPtH9i{+zF1HerB+i@3L8&mDrcPm>R5`$!z?j!=fy> zIrC!laFowll|M(AyD~5W81iu1>_6v>{DbNve_zCgUI!X|9)x$)#ZQ*`r^D8XOJ<$b z3=9~J`oritbUp-q(tD*tCyKrhI@odfqqcl$YILZg+*zD^6cA*?KHA-PDu|wSt?YHf z34jyScMQ%4c*^~c*2J-Wi!X<{x@;@RIXY0eQUtqZu2V!>vZq!i+O1Yk)eQf|P`Syk zh31j9zYW1I`RE-D2>Bp41L815m9YxVNE#+Jj5=1^u^38Pb&p*;MH=p%xA9Ccxnnqa zMnAJL6D)nnZ>@BZ8i#52Z9Y?;^Mu)Wx$Z;P_J&ubpa18M!G3P726dPtyD{M<+b7xR z0K@_GrqLZ@k?BOm!}TYIayBXp?2<;6duAo3Ob#{gt3sXa);CNf*3jL`ZS>lkz4IC5 zRm;7Yk!HpYgasLbese7i`DygDw_G_zw~Io8z>#pw$%MH2(o)mc43%fPbDDjZ-6x#X z8$6pra&vzy)Ev)w2^;NqYrt)rub;IRC83>BE3OJgg;$QW2OcrwN6w+xDqQ_Z4_wAvR9td}p+2Yh@^G1#LRos6-+6)wjtmb9-6NZu*_EZP1ws(iPQ%o8? zu-bC@hZ9!TMsZyr%y`LZxW1*${WVv`tdun03}I4Nr?o-mY4msA*vT0)l8z3s?XQ#h zaC&#GAi@UJJux*qt+cy8%%gDtqSvOlwd3oid5?a)6bI5${qA(KU3Hhr(~u8oZM{G{ z0xO6T>s$U^FbTHsi;ZvyfNIc?{Lnh2dZiaM{L<63JKfdk-Zzb9=1#Y0hOZC8l0J+C zL@v6)mOP?Ui1aq0pzFimL-6RPb4P5V&Ui_)fbvpE*=t?h^U@Rh(pV{bbUVw&De6y|~(Ons)~AZ8pxJ?|OHa zAN1&$d|%ICc&z+XM}X`k#{f(5Ir76HtSRy!-0oZsN^17~5jFut2Z z%V_lXtH}OlS9lx^f8K(fzSNf0S=ut+5Y&90EO^|y8>*NDxl`ka%9`OL!L14!m&A4Rb3)Np(@T*FA{2%==74Qq}H%-BQ4j|QTdbvvORqWTx{jlKJ!=PjvI zt!-xZ*KUR_%ppG1hqc4)uT2Z!gnfdXmw5AJ7jJrCQSVU;Zseu>e(Q=1oY#uM6wx=W z+}?incs)6r-IWY+Gs(i;Nk{UX?E}%r%1*X+_Xp;t)=^JTnz_$Bz1e|5s&DhSuQ6R8 zKe|~Z=sdYG!F00Dbtb+#s)Iif_`(^oCx@-FzhUK!JA{9xYH*+92Ni|cXt9TDoKyyee1%_^!jRH2G z4s0IRzd5126Wxn+ZJHZql7~a?u9c3{b+0i+^am>5h06p8(B9lAu?%^3o}PW`g8GRB zyiKv|4^dwUKV+OVfx==a-ZacjgMnvV0vCC@vk{PR-8xa67D%o4WU8<@qwLFWPlC_W zPIs}(13zq;GL@rLQNNM&V=3HXjcxOQC2G>xD(9%0%$2v_5Pk&DN7#p@-M;yU z?du}0MFsdg$+dLIA~RDM0qVBD=4{Z=_nZqpQ{dBV=B~{#%R`V1+pY>Yj>s!?J(?Mg zS{~ZCP&Nz%5W(ELPd0$_Q0h6#QF<89nqXyGt|Y6kg$o%jX(xV3yX_K}kNFrql5@E? zIso@-^`*u(1)Vv5?3y1HNG86*M_RI5KgtWIwY#vKD*iY4NaF|a*JPy#83|xtMAwrC zClnvRP1gV8uC5B!*)%`d&SQ0z^kl(Rb15FSY;cD?n|Kio3~kO{+o2{8$7WlPMda_eQpBNyN|2rM5KtET z*A9LBKfYO20aVbGmTo6^>;np8HveY@HQ((?*Y{h$|IduY*2LPZ9MI{x0n}U-Q5VrG zxsqNhG9vzloKl40p5M_x6D(XZ!Ak5^m3#0`yicll4?eO7-nW<)zaeR|>NH+YIM$da z^&SGWmGpKytYfl-A3v{GMjg9$;M|;&)a4`DHUGM|E~>wv829NfW}-q&$$&D>VBukT7{^wDSI}iHHv4pC`@b zP5^~D&^oMLsJ1KG*U_uIEcXPY;mSz3V!uJ2q#F!#|| z2j+n5E=B>($8A+mg4tzP9qhXo&KVw$K)_9@K!L8hv%`!Ys~9~+bVW4dXc3fqvwXkC zqfTQcQg`JpqMw8he-TLl(mKKzBUO!jlj^# zFZC}1B)QMlcvKDoAKyPvf34C)(kpjrUTtsnG7|S?oj2a%wO1Ye_3@kCH+=!-F715?7gty&$MJ)R~Fl zm*S7})Lt5ad2 z!!#bjPYG4|&+?6C!JFx&%Q0%16@8>uj{}ru*3Uy0u>8T6wzIoF9ho>%2ge_U`b$v4 zhgZ-UTwG3kNq`UcB`Oqi!qj&pHG_8?f*+!S$c7dU4(sNNFDA2nooC++khAs8jKu$|mdBL(yr;1#w73=REQ&z?=!U&AXFc zjfF=@$YPzM+wvei!vb&xT*`3gHWYXbb;8dgR285L(JuyP}o`}_F(65*k}`ez5ZA((6H zL@b7=5pg)&R3;`k9I&5<68j0x;gp3}=&6`|Yk-6-4}s)ORK|o(k73Vs+{}uTHbE z=C0iK`p95%Z^|92t%B|7z_v|f@?S85R{A@I@HTF{wB4w6_wH`3F7xu=o8vhd#Xc2| zAy7O>PqsVq0+P{_KG5SKf;SRsbV`v6#@7ei6_W3KREUnm!Bkh2Fu-(iz3G%M(!XLm z?_5@E=?^rDFu`jgqmTGa+~NQNgph`r)d0`&|yQ206H^~=*chLwao9P>W&c2`y7s> zW++b0DO`0!PXQw!I$oI!k4l~J?N|s@bA9@IeoRj9be<~IQHo6qUdF?r)@+VV`jGnm zWSun~8RhOfU1oWgXrtb@SCn}3Bftd4*>0zB$7UFpP+B$XPl1u}aAvEr?l3em37D3X z-o+O!1_Eff7ZuCBNdFx8u)FWZqAts4a-sDxkpS7$s$u=a8;AGF90P{XB^w926`e!$ z>xi)Ow7)vmz!wqChHzbcq`Yp_izOJd;(k&szv|9_W*fxyQXpwCOwnE;D|!Jo!|yoB zGZ4ykSy>B!?6XggP-Bn}4jeVsWM8x#0J5tcHt_w0){U@$u8JJ6-w%@bs!8~5!@G91 z_3Mp~Z@ET}AYj(9aLe~fyDH#5y~@2wQKmo*$G{%yZ{ZlT@9f?ppL6OnzF*;y`XPXV zKq8`J-{echWd1#Nwz)Fxa-U|~$n)w(`BN)O1J(C)HPw-orH8$!DAbuSEFk-K(UR3k zhDTFtmSG1xl?QsDA6w>gcP;MDv^#OF4vAus%@m?16NtLoF|W`kH>|$Gg6RLQx6w+bL{ScSoXXxbcpymjaWCs>?b#V5dp51Ct)tyhxx4FwmAiJ#0c-m+2$Bbl z>QUvpFh@2jyNX8^6$$FNWql0<2qiSHFV&Qu`sI|~AWln8N#};skR5&xbIS@*8N^t= zPj{&F{j|_ZOk3>>CbnFDx*JCu_xY#~2FN@I-QT26)}EEM+*Zi>QaA8-K(d+g!7i89 zBNK$yFijTDo91hTE84r9S8r=9B0f3%x(m{6)om{6C9%56u5#`H`TB&IW(=0Ub4n6g z2+SMg0DuTEeue}$zwq?`jvhuh`~k3YPsT1F#73Nh5W)VfV|Bk|L=Vf7>57? zAJFMN_`Kl@|t(z4qfT{~N~eQpNxP literal 0 HcmV?d00001 diff --git a/docs/.resources/alias/example-2.png b/docs/.resources/alias/example-2.png new file mode 100644 index 0000000000000000000000000000000000000000..106ca450308ddb89e874f9308b791026d0935034 GIT binary patch literal 15248 zcmdtJXH-+${_jn%0kC+EzWXO66NOD2Rz=UR;C;rRS03$ z4PN%KVBiH8Cx34!_q1i3m2u!n&7 z|2k*t5aPOsyjFJmi%Sjt$m*pgmEDgU$G(|A_&xE#iQ9I^#U%^R-F#3=qa{peYlBUjGP|9MpDBvp1OYk@TPO1D%Vn+{&C*pJX234x%dz{*v&&o8i@NJmX#&xw*THjex|10KF)J z#oon~CZ{XepGg$Bf3U4)dZXSt3bC+MU@>{eslI-$+eTpO?$k&`&^3JnbZC!Q<2^jy zXg%S~cFyu$XNGK~HYcWerK;F?bDCB^4M*X=r>==NujK-9D(yY0+s7D>10v?;{F`^@ z2gG(dReCzOSi}`$Mwia$z04L0?RrC4JE$*Wu~Kh1p@*)sGebDzmV|PiFP(FxJ=oY? z3#TzVgM%-AK{r(=`j3_Yw|l{(K-P-V#1q8}bm~+FDtebx^XdztnTf}Y&3GSp8DGWf zLmB(hoyT_&wM!jVSY?~&Ea(0P4HXCHOuk=s5CXDhM)Dg^FPzP;R9!w(Ha1o_$Dm*$ zr{?&hHn&hKkBz@`_Y`3^znqR@)~~wltXX`CxRHVqc7=zY{q!Egn0=cbL*|JXbKEg^ zvog{Ch76^KJcvm&;jteo;_SGveZ{oN-fBj)R;E{NDZ9Xki!id3^7yA~ZS7j|2`y z!QC?xS0_0Y>9528?03$HR~6fgtb975fDJ!kz+jCmjf*+qR;w{a;k#%{=OZDxju6P$ zS`a6}JBs4Weyp#c=-nZBx|IpkNYJP4j}?EThCly6>v00%8O?pp5;1*ut2sc3{6!wQ z4bw>JAsXt_-`=-UbycAP*u>S}>NpqrG2%M7a-?dHT?q-PO~D=*r;zYs+YRUlE9X&b zw}^^1Yv3V)p|>Zy?#5{uiyDz3$SvZ>k_o@e2ypMT>0dgh^T!u?LV@sM#D+@{qlE@V zvH+h+W^hKo^X}B=aJ+x>#^*DLpB{5pV*88nh6LOg4g`hM#f(?V%P;(IZhf+YU~IM2 z{Yas@$zzsix-B(?`K}HEq1Kq68rBqSfxy>t(`M4%OL5TS*vI%DmdNzCe=xZS5MTxlU%a*3<|jQ#DI-s2J5d!`s{wyc&KB zE=HQFh-MN8Hg;zDm&SEI70s>c?nS<=jv?fkp~>ga1xwB}W7t12?$`tyL&STYm<*Kf%1Tv+V?~_Q}}r_$P4=O zpNR0%`Cz+&3|J@AZPE3?XVv6k2NB&mCr9{^1p!oU*ba>H0Y8Nw3dl<7iN``9(vN8` z`%fDKwVT=LOR3ocw$UqZv_=I+e{WjJXx?$k#jpGb$x=n;NYuQ=k}C!PqT>lHG4A94 z)8heJ=&7eVQBAu_#%l|@0j|}QLSDpC9P^2d;l_3CWe|RXg$)qvI(fSJDS|c5-xSy| z!2i>gY*XTLb3PY(YdC3|C8@WDoWxARQ{kNU1Zo|lPiZ;g9!MBxJ(agZTn=kkd&Doy zBG&gQ4J11wloyA~42J52M%(k4OOhD9Vd<+gb4N)jOUgcJHx@0o1cnHk*q|x@E0o(_ z-$1N}ItPaf(Imb1usq(QL>c+k|XG&giPY=Ocg+4{gNtuKSW z6XvN5w*4BA7BO0EA+0Y^=@*K}gJ%NPhIkwbV>pB2zhvvBF-l)taKDPn7wxA)9?maH zWh-@0b(&ywYnwGAPJzP`R!%nO-aAIGy%z8%Ws{Xs(oxr?aKTO5ajKPZo zR3oh$r@EV?Vbp2mxx8W>Je5{zkQQl?$(<@uG>SNm+<~KfjcxznAI)mXZoMGG| ztEENZejj+i&Osm?nD=JtMnY6Wm7Mx$_GNwOSMuvNU32rNJ3*fJN4h@wg%VS8siOV< z?nl$TwfV??L&HRchmt9%n%)|k$BXSD#%1?!cS0CL*EzRm=dU1DqsQ}CLJT`5+6&wk;i(-evJ#g52yhw6VRbU=TEXB9hb*8j6q1H@RMkQ^8(uTj- zAnVP1ey_98Jr1Ssw4!gVXQSNC4v1xZ{@88qX$KjMVa3;x1cc3rJHwf&OJlwSVS+LJ z8-7TsS@Dp2c(k+WhR^ow6%ihlH)Xh{w+^SbH(2t@&7f$bCRKTs(a1;I6Ov&N--atG z$tLvN=P%{=pwln#@m$gurCXoWZ{P`P4z3m=J}mpqzT*BYn;E_LC&IBYj6wsvud`PV z6@TG3R+_~!HrIP~-O__RKtP-KL!BXVUk882YgVE?wg7Ge#}X;mxSUL4p2wFk=EzcN+R zWWFQD1L6+ZlyO>ZSf0VBQ^t1TlY7yToE%3x7=(J(i3>`6Co=Fsx1oMvKC4Ku`&G2^ z^%ag{mD8$y6QY>fOPD%4Io`itUBj%_&G8t@obhXiU!AW9X1h$ac7C{`GV3Buc{GnC zG!L5{u~m2C6)uC$j_`U^&RzTh7H;bS>lpK-UBvj#OHcyRhcn8OhY_j4lpz;hEfDnC zDwbZWY4oeYAPdB5>uhLC#F$!_8FGgeB3H*1YKfJXQtnYv^Lg&C^PXD5E)fz#xirP0e;0b-lNZFE90*0AEw=>4JN0fz`zoFPgBa-x`(t;eoUbz^P=of z0bSJ(*doI4QMCv$(fsnz-b5`&rB~*@{$U&03O!@D;7YBIzMR#Xudz~_QWmXzGm(aa zXB+?x^fy<38rYpvB)|!*AJRL8)#8!ik;1hSVAeR+DRj2s(+c$bF>aY|RI-wTy^h9d z$Oosyq4*~a)PiYHBEQFj6~!34dLfTFuG~xOwPx&+7v?E>>H#UtBDj=w0?kRj%vk_* zTYth#AD0dg`^PEP>->zlf7_R(xIkMq{%W>S-`jCoIb&d14PlONg&QnJ?j~)tBB-Bk zFSh!Kl#Ex>Br_&H3WKKUzbc@36v}8_?8DEVD8%+CH#MKS(zXgQnZz@Kz<5x+vcZ*Q_cr)DC&ahVWhb~;P(%S{C zl_qzW7q(!+*B;O{E?z5uS@^f%wS}Av&@#M+lOyNhs_C$K<{ETl-Htx6ZZ*>Yt?}4= z&rTGdW^s@DWNaJ%%RA+#5Tb~kmM(#S>P|vREzB6|d*w_sUGElt%J!*ZhxlNVMyl#3g%9rh@$Q6pXYX5H@?tE% zv=WOZuhw@0LwZ*wNLgOpamsE-NcFa(rBrC}Qo1X}D)v)J&-jF6p#FS(Y6VQ$!rx?l ziKpy;&9ZOex3Ei%Wyan8Q+o@+y94p9Pu0KHq;}mOv8ng`&XR~=$7vg6oITB{Z3_dl z;)P9!mZJmtaWDKFnPs~7BaTus4j8ia;oYL^-uaH*pseRr$$5!yY(JdjbUs=UDk zy#&=sbo3yl)sLOEv)U^UfF2Iw^?yfXa-wo&EMX-nqfPTtNbco&IV68Gx$sN>r6avD zKyPQyL+@-8ZN9TGXt0M#eAObr@M&mi;w^lLZYQszKXD^T^2aPZvD#Ch)5U6|zVzTeq;L_k!N@Vy z|013hk^g9PW8Lr?2>sn}A{dG3(7IZ@ql==@Y@3i&0airN+~lt{v%Jj$f^)f{OSAn) zW%9mdtNuWL$;(c$TO@ZxUE_w(b+rV2GC9}eBb}x;AD*y-u>2E0mm94-k#gf7MRP@a zPAlz7d2lFZgq~_UzHcum08YVqc*_A;$heJ!;G%V>V_8KaObwwE4*ac;0Z9u-N!+>i z6t6d`4)|HQn4X!EKYv+j6MiRT&7}2!vEcQR;;0)zhu?Jf=N*ymjghsJu6lBEmFWZm zJXZR*ngWi<~1IfwJapQQG#-{3G z^aaGTA^i;0-C)YKk|tF|tp(6~GYn8ep~h)wM>;mOe_2Q8=m)VJ28|*I)kp0}^59p3 z^A_-^ygp#mvYzbXax6b;aA>A9gap?AwM6tuGKRo9f!qgwu2eK7oPZ!IK!=+he{C$g z6NYDIOz)4>c9qjo`8Bg_M`@0lTqPr%TkL9Z|w<%KIBf zywhn{xn$C$c{@L_9Ly-FLzv_YSse4P`qU9->lV(h{mG3D{nJAeq6G1vIZ2%&OuYm*&YUnBE|sEeA;gJlyS2`aVhgp%xV)QzLLY2pB|J?z- zF#}#*Npfjell*0?_^UvWJ;zzwNd_)8TkvVDeW>&~%i9EOdpWI*yVPYupu~#-o0rPA z)cI81az_i$U6raLB{wx)@!~4p!ejY6d^H3JXSd4zt@I$%4?@O>G850YW}0!#Y!5Mr zmKeZt-YiCZyeG_XZgbDc24)R@^`I*zMPE&m_>DlOe49!UBXYg&fvlD1ebXl)Sx)48 zUdrBx=DNFWvxM%x?OxfKcx9%_9o2g6<&3BU7fn>tg z0P-~OX>QQecIo!_hR{V{1)Qah*f?tG`iVO_=oR-X*gQ#IEfVhK!fldoWa@m2`QBZ@+) z%12bb?86*>6LyV+uMW0IM5tO&TK9WCc1vR5 zn~xxib1xE?|3dC2$`Vr*ie1#gfwEqbf#I-`xfp`~*?6vG{67tR8E5pJCp}gSq9P8ZJ#nL^ptP6m7=3yi0p39X*3X(cTg4T3 zXuM89Rlqz*&QGn4=9+J_e4_X@;Qj;V$%z_Xtx2-DzQ_Fn7`Fu=`2gPo6lBe!?s}%{le-DTQ$ozLh!&--Z~U(Qr)0wAtNCAi zTVH)%fAamUaF=DRjIz)edJ*pCEwX7MU=~X(M47pUOQRmE9?VhKoOo0A1`=_R9_2J^ z11=;%(rf`8-|&(xuk%?UNf

>S%%ScxIoBB4#xWbx*DkfC<+c0i581T81t&yvF?w z>cvNu-2S)hcXcYNVhgfigMj}O0$ijWCbVOS&qL)kCHNr6Z>;+elN~2oMO1sESGl~h zCk*9@f_&~?8jYB&D;*V4gL;Wq^Y4D(;f{R1`)#_I-#|g3a;;B_-4BNP0i8ElL33?i zIEdmP9XSen9Rr=7F+BP^CeyPr5|EI&0e%)%d4aCo9`^mUZTuf`n95T@oVoqPUkezv zGq*nEKb_GBza5eJBAz5aF5n2?reu#u^*Xd`Xt+oz>O7Nwj!4efxa6Q|={9zYfbJnd z66*rkrVd~)BnihcSOYHZN}N34fqG^Q4iJ!I8q=3egb*#rZ*o4VBHSU7cN{O2(P>ym z?GrAoVV6J4)G?S;VnRR6rNS7w1xeLPB88R*0u0m^t`G+N?xYMS=u!+SKh@hXehQC1 z?`bqJQ}n0HW))=@#GylqecxUQ+u5#}e;&@&y9ti{24%w_Yv8dIpQ@tE<1r4(8G&yI$PBbTe8}qzX zn@?-fJn&F2#|wT5XA!k#XoT0J7PzeYtywjTZxxHSu-ZS_MpJRM$#m8G1I@X*smfuj z-mLN1FIp=gT`5}R+X)@b#%?oGsqFg5Nat<%SzGv`1Ygc;5-YsPzDI16dGG1s$a$SJ zMFey}_W*J9n3!h+QjGTm$p5S@ivP@7LTClnSRqSzb&FL#oX{Sk=e=&AfuZCTBe&8g zDEbV;*VrT{*b-I+M^M($frP;hytLF(EWfm&@1=M^Exhv!uW0eB0l29?=VMv$XmPVf z5hTzbT{OL+ojrJIvVZaSv?gU6w>fX^ZnpYQbQhkHPidt`W?dO8rAd?Pm>e%^ zl{&ysHN1am>Q@K%i+c2!nI0^R@%kEu^@>)a8R8e4NemRz1HTB)Gf&?SbosAqAG`05|F0_^Y@6QKH2#G} zCZuBzo~?uZl5Exl_B{v55Ikm}`kx=k##o=`{wJLxve;1U$iCIsFst^W<3=LztNeK!XN1Ro53CWI4Sd=_x<{^_r0?M zwXILs+WY(Y|db1VCeu{_b_Vr$qy&LAGo*~3Hd`u=a=n`FAMrC71WN0 zQRlD|+e^i?uo3Ll@r|a9$kP<{duAl*rNC20y9x~1NN=9A0#lm9Q{tx)lym5Zw5E3j=Yxw6-;bh?;c?Wp>dhoeKWf|4}y+?Vp(XjzhjOw15 z>=kAJs}1TY(VJ((l@s_ED`#*1RgcI0qnagd!J`c+Df?_~0yX$CP~iq6#B!+&*I7%C$bC6(=5m@Q-PV?pn`+s?)zX_$Q6X{hJy7SXFh=aVq(a~6O|bn zkwj!38YNubK~jb3#(vjYU24gVNY%j0jlJt%21?6bY%ST0=yVjVu2mDYo6B|wtD&km zo8>f4Lcs2r&Di!>A*cJk7nF3cyHU*`9VHm^g4l}-OBR4ZjrYoUi{{L5}z^@W;y3XuX~3^+vc5hK-5Gz06%137UdV(`QZHYe5PIy5$}dNDo5$Y{O(8!&)?Q zxX~B(Cu2WBLBd`>+^In^pX@U()?Llrb`C)wq7tW7-SH>_u#`uOe@+3&xFFlj5iOb0 zoC;OiG-_M18Zjnb;}> zhWwLxCfyA``#2LDFp;N(+8qVEu#-Z>a;6*BpTcIQ*4I*lR!aj03q4FClkW`k{|aGC zE_Z7+73T4Dl)}JFBE(DeuXefmC)3(^^OnJzt?~V$_se=74 zQ(pqg7zsbqS8>kl>8P)@`_yy*Lc|-hG<$}o*jl_k?)$3bggg@yux*uF{B>~^bY~zS z%6p?^Nkja;x)HPdp2cFW7wyvwa#-shBlFKj}*4GJU=% z%4T^a=9-5shj6ecY&DN7*p5H42tsb9Zr5UVKSLQqO+A`)^YNiDu1^2Th^A0Nm7{#} zQzPbPC_#PrvU5j46m$NL=HcPVa@;C2RNuRTv0qm#*QUgx>qIW7w*C<(vzJ4|dt+Qi zs6wqDoOhVlXeXM5e7u6=ihHR0A z+Kz{%eKy@PVo%Vss7-}S)uETs=1r=N?IK$~gjjy3rmk84#Hg@r(V;#5Fy}h%z4P(DIM@9!w@YYRO4^D! zkRk4R+M{enPX|&7x`2s|wap)r$|`fb20|Qn(ux{BJJN*6{_ae<6#JxhYQ`DLyH;4{ z5nSnh=%5`ilG-WIaYh+qu;JoAIl^Lh9h!YlI7P;E_Os|)ei03_Tzg(K8z@E--#vAL z|L(;pGSgT-pP;IHl+-m*8!!pd=TWk0l9ehI!+m#8!qwpVOHrtW4<(|^$(g^(W?Fw{ zIJD+54YA1=wsnHkZUkGayAY)WTps04k{L|H6C}yzo`$ICucCtwOAE_k8n6|4AlfRm z^fY9L^sd4-J6jMsHp@9(Ah!0N;#=(6dD0CDGH#B7_}~XvPhrVQp@)(=pzZ2}TGUgQ zv{JfT&-MXSu09}1KLeBFN!z-8ggYIR>oMxg?8G_yHRd=M>{Jt3x<2xLip&pRN z#?(>%Wd;~*++-e<+%zk-O=o40pmQZwG$^~3R@sxfr%huI6eUl77~7iml2XPL@@egy zWX;<9b{DVa-Ar!;x3KK;r{AblQ`S9>3r2lV*d!4&8UEK?^HEYxH3{m$^f7{LC{C38 z@b%yn^!Nq(YBzG@$@fzGMQp61o6bl+(Pnf=YOLj{s=^|4X8RVdW=B%{LN7!t5-mSd z)|$LgotiN+&KEdNW!Q$gk8}($NL^1Ye7obx(o*po6}jGGXMK{GC%+*5Q-@YB+JlNK zwWog0XCHe$m43}<)^|uI7dOU$M?62V%9+hxtq|~(`SsUo!al?~Sw_Y%uS#2deh!)Q zQiWRxgT20@8~?orhmU$pbsVTx8u-}bw=;%wF#GDeZXeak?#kw~q|Fc1FT#>4Y(Pnmvlg`}AZM-F0_-qYa}~G+)-stxv?~+jI3eV$Uvy zt0}@pBu}{M;EMo0HD=EDy(+ZyJNP)6vml0SQ>Pz{jrt8i5$a^+WX z7{jgPc#JN#*oL~snks;?C-*?FK~_nJ-G^@}qq0+rH&@M3P6IYG)HuoIsA2V(ehzz= zfwG5{a~j301*Qp7Sy=x_n^nY!QHVUU&v~>&6bZN6;(&axfawMpd zd}_zujnPr=8o-8Qc>_9~C+>WgKN3*CDXE?T#@r2JM`|fv1a-6lWy85 z*WFIFn|10RrF^nKi;m95sj$^qn}1H0*?eGpo+&LEXU768W!$>45c&;oG3|)Hu)Qu< z$(#ipN3J-%3hJ~zvd}HE?F3-AJFuRD`8o0@N??tViZVaAfoogeyhd+cXZv`hcSUJr z50y?01r7c~S=W6U_!3UX_qX6@g`=x z^+tKMm#Y@3|C6I=aCCV(qM>pcX(|ag6{0o;x>;tiY7kO}<<~dT7c)W?!Xi$Mb@2u%f5uc#ERj>*7pja^BvX|pwFV5`Lk-K_@HRK-)3(GYr zfSw2c^A~ymbe%7dS8GQ%D>Zmiwetj8uQotI!1BY!$DRlV1fIZjY$7|F&^vpgMs8Wx?wc9tZ z)r@sxHS`<3ElX{;tm<)w^twq6pXD3%i`S|=;v`QI;v`2M4GYoy>Ba1l{KbBxxHC9% zjZsQ5n+7gM%v~k9`1`ffmnscyujRwvjw^#GuV3#$@}GUz6`gDiuc24<_5a+U>o>T! z5Uz=&jU9!z4kX)6zzYmVGdZ2W)iE!KNz;iW1eTGPJ!bbRW@_l}YDo4YHZSTdR4*rb z5TNsU2r_=fU=4M~JcQ%ZkmHTT%c*A$y)hB-iD-PSx*6$xhgqY3O{qoSc3j4XHdv*Z z`O7~OjfGoakC+$;JIavRz&!Au}p{13&&Uq2eadaTAHnGa1L1VrxJoV_QkzocJW*V zpG*pUCRUBCk=K05AQuBS+;8f{{8k1tl=|d(NG@hI2)Y0bpJ$Gh))Hk;T#@CCyNbVF z3~m@$Z>7LtJEnJHQyF>XaYIOL2fJJn?pOON#%I&Z=haY(cdRR^9I8PAn4Mj zE*rQWojKGH6Tf4J;xCieM&A&{YAhVT45U6VaOI1D_^Ev^IODhV(j!Q;g>r9CZr)on ziS~D`dgs~*%8b3iaOF5Q_6`YeEXtOo3Sl({FQKdH@;NR**IOpskh7kOdr9-zG|0Rs zB?Y*_gwMOgeqKj+z@1^qe`lp&%|hYxiG2|cuzB!$4PTff7Y@STzNMSP?WPGy9U4EC zCROD(^2H#b&pNjstM|R$&@(bjkCzp-Ag6VtX<+sa>;!6q6h8)uLN4Xp0ARyFtn08j zd2p`ePq*v&fWCP!c#QDOGE4T%9y~i#=Pnf7P0)$`n=)}@a6@Ptn0+;MKxfyX=_fwp z%JI7nYFKr}P~;16HJHNbn-qg3Vkn-dYp@C8r3q6nQY+4?U6Nh%JY-uU8h6A{^s{LL z|CwSU!3SKD%2wr3U3S-g_UN;oOngo;kBH5})~T`>ask{27qCM*yko+N)fu;#GPSY7 zCdTlMZQhI+yYEOZoCblk6eP&&BT+ZfJRwdUAEl+w4AoSdK_AU=&mgnayhmmi2SFeU zQS)^7n4^V8&-k@VR*X{T*Ga#@rgX`B95UEikH1jgdC@Or_34_l>xhrY$;Mod`70T; zW%<8`f5YP{p=g8k%`7jhTNEHd>HSt8@9WgzzeFq@T`3XwVYx8a)BBYJpK~_$m5#Bs zZp$l?3+3Ts2XLuR1nCw9YoF5j#a$;%IDdc*xhKf^*(Y4YRQOzz+gT> zk?bw*`2%LWnjiL-h#K_M^B^q)(H9YgG32o(am!NHtnhY=YD(wG8-GEcF`gS|)eM;6 z#Eb41^-`1?q@63&IRA@(C2A0?) zo8nEdHt8GF=&+EA25-)fx52ZUr;cVXzEg9Sa|37QB$23G4jbjkKYLnlFI%dIw~&c| zkO68$UGs)Upz`VX2M;Sk;cTQ9a#Wit%QTGYsxZMS??0hcMtUCEMen2))wF?69dh1?qdSEPVi+m;JPNgl}F5fCb~ zwRaMF z@*A6fU)1p$Iusfc)3>IDxAGwoTnw9jhjKHYhbLsNxW5w_?>>M%HshUH{45NflG}4P zQx(>YMDZJ2Bxl~s^3I-0wUfoh{>`73=T9JgIHf|Hy{om(@7Ekz4vJL_$yVjCy{dx; z7?fAaPPGPtX)Rglt^;pW8}6lYJ##T4cpSOnN4fR3DKcf4dM)-yGBKVFMV18%*JpnS zb&xPGz8WK#qJ*d+ zG%0A5SxEn}9Dp7(3{s2VQv()Fxj`}{Yd(bENinQ+{uv>k7>@X9*1}HG0em_?d*g~; zBz-r2AY&$rcHDHEP8>PZ8v}F5^YbIUN^906$k7}0J<8uyx{W8UCU@)MNjRr!i-zQ* z#ulboBUPHtXx5&8x-9f3Br64NSJ0>F)Yy&>o6NjHj&|x2F}Lt&2L*B~$n#1;>cfeQ z;YcQ?sS?H~2W0Oc@bYzq)f~>cB<3~iufwl@nk1#AQ^wIksTW=|lv-pi&XGnZ4SXuG zp*OB8Pk^^rmDKz&Kjr~~=}6`B&-hMG&Q3FZYWJPiB7pH2Id{{E@z*wZT;3@%$q~(! zzD~OsWFF?o-);GV`~=p3&xIdY$hC?9$r-|s~ayqG_Vmt?zYL+|xgpK`## zO-2r{ay}k@WnRW%boP2I;yrzH#m>Y$szN7fxW!_|g2I7A_JuD0&}d_fHtKt7Op|qg z&obT9-<*2UEp5&IZE#zbFdb~GF6_esof@=hF$FB+aqsqvHK5$~`$x*|hB1pfc#D{P zl)X>+ZA?c>(X8bi?Ld~b(PWLKc(P?pzq*Msb#6SdWkF5!n8a~&#ZD`uUZvDNMa9b< za{7g5&U$(&b{F(04-^UOUU#jL^YqZ{x}kZif!lwbt0zJv2kVa*@Qpz3ZvTJLZ5OV?)AXzcj89Qn|)#TLYAGdSE{EL5O5+sApO<6;W7DCrQg zzZyqVeE*awet%+kbe{)%@&s>538dpv{e^v6M1KG8 zWfw(Ttigj-vfVLzs)JE2xWPW9shwS5%P9}EbTSpPBu?`WX|8DvCXl`V zt*5D(X?i%oMb$jD5qpUwCYH{8DQ%eGIC1_?b)4@X2v~vs)0emn_3Sr&*}hX=@F3N( za(LP}uO`}{P<4%q{P}ie%o?Oz?pnql7qYkQ9;tpPe`Vc(@6;umIwuWZ z|5LaVimKuJ(Ex1pK0e@;COhx<*3f4XexQ+`6Q_7$4)8h7(WKB|N9+{iBhBC*dBzvt zMXC)jky#JXtD$W>P6)ihvGy=%qPJK7g?3zBC|MitHN)XC;}tx3n4xy%TZJMrYU#}% zY6z)oKp4>0@1GqU76$<=h{X%`L9RQtX?( zUMWmQ_Osw1S;%+a;un}@Gy-N|g~vki5z3K?!xO|&yMveGMHa6wRvvTDcj1pR>^(9( zLe%3JPDEjm!Bf2f%~8PsIOhGM;di$IzZ@6D=cp(nF_5$6k0N8< zr>HItxMg3~snhQ5U)jpBoc|+m4kmuVEu$E-RxRTdMG5hKm9U!HF-fm~>OF`TXJ?YI zgeqHdUKNbq?Vma~7WQhK_ee5knDdRXkhvW1$6$i^DFRpMjQqd0!tE74m4EiE?4|`c z5E8SJwafs1oS5Cmp&t%;Bx2VNs{T*}*+4LfOF~)Ut%s1A0Of~J0DZqtdK8Z8PJxsc zZU;plH1RpY=f$X${uelsi>0B1K&Osf|82jme4%M9#%r3)mGfC?;n@AH|Mg?+(EWyq zMFwGmk0*<}=u-c_8S&XC3ION%elxa+i@Nr4AIfrZNf|b^7aD-`54L&!Oo})6z}1G` z?3Pjs+-Xzv07$1LlO@@0vaPY>(YCKE?W4;WTJ$nWq^WFbB3_TOWpOO;(SHB22R+>_ z5-HoQ&5zZ#L`?;zc7DY4^{O#jc;eQH%`T4}PnNii;%*3C{fEv0H$Qs+Qp*vdvUy8pw_R4O>Ns9R5NB!9l%ZOhyDLV>3&>OKK1>-9)JIpJ!q QW;y;kZ+))vtb5%51E{zYr2qf` literal 0 HcmV?d00001 diff --git a/docs/cog_guides/alias.rst b/docs/cog_guides/alias.rst new file mode 100644 index 000000000..1b5c43d6c --- /dev/null +++ b/docs/cog_guides/alias.rst @@ -0,0 +1,277 @@ +.. _alias: + +===== +Alias +===== + +This is the cog guide for the alias cog. You will +find detailed docs about the usage and the commands. + +``[p]`` is considered as your prefix. + +.. note:: To use this cog, load it by typing this:: + + [p]load alias + +.. _alias-usage: + +----- +Usage +----- + +This cog is used to create shortcuts for commands. + +Here's an example: + +.. code-block:: python + + [p]play + # with an alias, you can call the command above with a shortcut like this: + [p]p + # "p" is now a shortcut for "play" + +In this example, we made an alias named ``p`` that will +invoke the ``play`` command. If you use ``[p]play`` or ``[p]p``, the result will +be the same. + +--- + +Here's another example + +.. code-block:: python + + [p]cleanup messages + # now we're creating another alias that will group both the command and the subcommand into this: + [p]clear + # "clear" is now a shortcut for "cleanup messages" + +In this second example, we made an alias called ``clear`` that will +invoke the ``cleanup messages`` subcommand. Now if you use ``[p]cleanup +message`` or ``[p]clear``, the result will be the same. + +--- + +This is the basic usage, where you can define an alias for the first part of +the command and give the second part when invoking the command. A more advanced +usage of aliases is the usage of arguments. + +Let's suppose you want to make an alias to ban someone, delete 7 days of +messages and set the reason to "Spam bot.", that cannot be done with a classic +alias since the required member argument is the first one. If you create the +alias "spamban" using arguments like this ``ban {0} 7 Spam bot.``, ``{0}`` will +be replaced by the first argument of your alias: + +.. code-block:: none + + # we created the following alias named "spamban" + [p]spamban Slime#3160 + # this alias will execute the following command: + [p]ban Slime#3160 7 Spam bot. + +For a more detailed explaination, read :ref:`this `. + +.. _alias-commands: + +-------- +Commands +-------- + +.. _alias-command-alias: + +^^^^^ +alias +^^^^^ + +**Syntax** + +.. code-block:: none + + [p]alias + +**Description** + +This is the main command used for setting up the cog. +It will be used for all other commands. + +.. _alias-command-alias-add: + +""""""""" +alias add +""""""""" + +.. note:: |mod-lock| + +**Syntax** + +.. code-block:: none + + [p]alias add + +**Description** + +Creates an alias. It will be used like this ``[p]alias_name `` +and will be equal to this ``[p]command ``. + +Let's develop the examples given :ref:`earlier ` a bit more, +the left part of the command is the alias (blue), and the right part is the +parameters members have to give for the command (orange). + +.. image:: ../.resources/alias/example-1.png + +One more thing you can do with aliases is using arguments, a bit like +CustomCommands. Let's suppose you want an alias that bans x member and deletes +7 days of messages. Without aliases, the command would look like this: + +``[p]ban NotSoTrustyJAID#0001 7 My random reason`` + +A classic alias wouldn't work because the member argument is the first one, +and you can only shorten the left part before the required argument. + +An alias with arguments can fix that, you can define the alias on the whole +command and replace the required argument by ``{0}``, which will be replaced +by the first parameter given when invoking the alias. + +Back to our example, let's make an alias named ``bigban`` which will be +assigned to this expression: ``ban {0} 7`` + +.. image:: ../.resources/alias/example-2.png + +You can see in blue the "static" part of the alias, what is contained and +doesn't need to be given, the orange part is the arguments given at the end of +the command, just like a classic alias, and the green part is the positional +argument we defined: the first argument of the alias will be the green part. + +You can add as many arguments as you want, they can start at ``{0}`` or ``{1}`` +and must be in order: ``{1}`` will be the first argument, ``{2}`` will be the +second one... + +.. attention:: The numbers must be in order, you cannot use ``{0}`` and ``{2}`` + without using ``{1}``. + +Here are more examples: + +* * Full command: ``[p]cleanup messages 75 True`` + * Alias: ``[p]alias add fullclear cleanup messages {0} True`` + * Invoked alias: ``[p]fullclear 75`` + + *The* ``True`` *at the end tells the bot to also clear pinned messages.* + +* * Full command: ``[p]repo add SinbadCogs + https://github.com/mikeshardmind/SinbadCogs v3`` + + * Alias: ``[p]alias add newrepo repo add {2} https://github.com/{1}/{2}`` + * Invoked with alias: ``[p]newrepo mikeshardmind SinbadCogs v3`` + +**Arguments** + +* ````: The new command name. + +* ````: The command to execute when ``[p]alias_name`` is invoked. + +.. _alias-command-alias-delete: + +"""""""""""" +alias delete +"""""""""""" + +.. note:: |mod-lock| + +**Syntax** + +.. code-block:: none + + [p]alias [delete|remove|del] + +**Description** + +Removes an alias from the list. Check the list with +the :ref:`alias list ` command. + +**Arguments** + +* ````: The alias' name to delete. + +.. _alias-command-alias-list: + +"""""""""" +alias list +"""""""""" + +**Syntax** + +.. code-block:: none + + [p]alias list + +**Description** + +Shows all of the existing aliases on the current server. + +.. _alias-command-alias-show: + +"""""""""" +alias show +"""""""""" + +**Syntax** + +.. code-block:: none + + [p]alias show + +**Description** + +Shows the command associated to the alias. + +**Arguments** + +* ````: The alias you want information from. + +.. _alias-command-alias-help: + +"""""""""" +alias help +"""""""""" + +**Syntax** + +.. code-block:: none + + [p]alias help + +**Description** + +Shows help message for an alias. + +**Arguments** + +* ````: Alias you want to get help from. + +.. _alias-command-alias-global: + +"""""""""""" +alias global +"""""""""""" + +.. note:: |owner-lock| + +**Syntax** + +.. code-block:: none + + [p]alias global + +**Description** + +Another group command which contains the :ref:`add +`, :ref:`del +` and :ref:`list +` commands. + +They work the same, except the created aliases will be +global instead of being only server-wide. + +Please refer to these docs for the commands, they work with the +same arguments. For example, if you want to add a global alias, +instead of doing ``[p]alias add ``, do ``[p]alias +global add ``. diff --git a/docs/index.rst b/docs/index.rst index 3baf239d8..64424d054 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,6 +32,7 @@ Welcome to Red - Discord Bot's documentation! getting_started cog_guides/admin + cog_guides/alias cog_guides/bank red_core_data_statement