From ea7f7ea875f6373625b80f2b2d34fce47fc6e629 Mon Sep 17 00:00:00 2001 From: hubster-bot Date: Fri, 12 Jul 2024 19:36:44 +0100 Subject: [PATCH] Adds more content --- docs/assets/ForkButton.png | Bin 0 -> 19471 bytes docs/contribute.md | 64 +++++++++++++++++++++++++++++++++---- docs/userguide.md | 4 ++- mkdocs.yml | 11 ++++--- overrides/main.html | 2 +- 5 files changed, 68 insertions(+), 13 deletions(-) create mode 100644 docs/assets/ForkButton.png diff --git a/docs/assets/ForkButton.png b/docs/assets/ForkButton.png new file mode 100644 index 0000000000000000000000000000000000000000..9632f2715fe6ecdacd1c0d9cd9238a0fb4ae29f5 GIT binary patch literal 19471 zcmce-Wl&tr_UMhfli&>Q4#6$ByL)hVcMI;p2^!qp-QC^Y-5uV^Ip?|WxgY*j_rtB* zRm`w!x~seQ+Dm$^-wufdc^nL6i^|Rs;coxB&j|4+91KbWOZx0DgfwDvAk$ zR7~I<11}&<1!M$3K&oTl-}E7Y*RXct8jc_!NWFjmKnHD$j6gu7!X< z7;ivd>9GylcmzU#OG${Ah0@4yPbK@q~dBR}#3o z;y{AT4~0bH{7y(n_Vbr0SaF_p%`o@p@^V$)MS&ID-s8Jh@EFhJ*#+b4*%`~HcX)*D zj|emr)c>?NrD=2Du+aasp)f`}G2#ETy`NZ3B*gz|4uS}4|BON9B$AaC_;;`Q5y{S? za#YSty&v$_QAOtZ5#0X_A*Sf-!vAMX9J+y;#=n0lNpe=xaM2!V{A&wp+&{f(y}o~D9G-?#TesA>b)`J z7V>}Jgg>H#4>Qt(YrbZ|ZDAJRcg2sd=&^gi? z8bt(C&sIpLE~qFKSoRbHM?-3j3Y8135GV3Ucq*lNdV(rTEmFbsj5fPGp zNv#kNr-bb*#@lj|rN4Q9Lz${(p~q+-4|9%1 z=~DOUs)2{?$JK>i;*aX)kp0>C%R*pw{rzl7)g}kb1KIeTEX`19qfUNFik^rYJM^R+ zST+EF_yjof{rGlf7Py`_Qvi=7%2rNbNGrT%odtA8GQZ2m6T#jw?{-prjJzH`T%xy< zqEfx--`W2ZeAm<#w~hSshnOzNqIY~;=KNeyr<6O>^>z43%fUw{QKSW;MO=x9JAu;G z0QH;4HInzxY+*mQ1jChIH4v{f26ff>Ive@-?K^1_J=Uo)sd*dq?NW;>cVL-%>}nXqXKEPxlWsai*> z?rJXATb=S(twU_AH)M$6t{qQ11U;E9W9r@2yfN{V{Lj8TBi26>&ZCQy$hx{4CmdiE z70e&sdA&7D<^Op7k|B>@;pbszhhEmu&_wzxag}X$Val&J(#GWizP=sNO_c1MAECU? zimMe^ldb1_1&dqTIUBcgWX*?ELzAv{AeR=;MbvhKHwx7+)bM{QMudc*Ie+2_i7XPH zGB37np3@rMm+_63(xnNeR)j&puSvKrMu(CZ+4iKwGm-#^;g8 z5^2<8v$6_ByU0Qh%+P2PC_6(!D7?J9<|4#b_N5TE{%%YE0L0(=>&>;bO+PPPOKyHQ za;HhgU?Zks72SSOnrp6})*3omSSF~oeKjF?2+K}l8_9^rY^mvzL!kboyX^=MFK-U} z+@)3UKmgd@{C3yje04(12{=%y3wR0`!q%gKEYO@I&=)5c9G)SqxyG?bdY?TPpFIlu z^B9Ycf42^sEBUx|C&;cn{oG|lE$X8HyCxs`y^(lrzLul~;x#)lhDMM_XIo1Vf;~MeTHU_TA%Ld1_j+3}+S-Y`vijOZ zTv&9(f^3e3z9ziC%~=zBa-IyR=?dwddQ5YbA(Bg{2k^`JBE7#L`(Ja9(+s!}R^dl=nBu10~}}mTs)JUGJf7Io-pfwqOtl>bo0P&Nx-*t z^S75D4EtD4eCF|)*oh;bYZTFoPl;f_j)-3wPi=Wl*K6e^dA`Ten?$!=CocY4Yy*g= zq726LQyP;=BJODnwd5I_8uu(tb~@>q9vsyWRutZB!91>?<&^8RZhT=CcCUvVy;DI# zUW0^$B7Bx)(vFDOQZ!JU4Udq%a-dVtTEmuHv%476cyqc!nJ_jX6e{c;h7S{$loYYo zWr}siKG%fkULS|-FAz*f3EwuL6}E86d0D%+Wd1OHVY~}JiprU63#-<&2z0k%%f#Qn z-S!UIUS1q94`U@+H$((vHl?J`{U|@R`g=d925AOmfc{lkb<&TKm60N%ejd|D&_N)n zMZ9Vv%_%3bE0d=|6SbGob6c`Zr?b1QEOY>dE@CXtI052>^k^nui}c}qJ@DrfyhRIy z9_b|4_t~Z4So-J%lu8Y~JgYYsT2Y;3kc^=Gp!Emq%><~+bRD5~hD9a!BDtBKi)tb@ z-1i|5B^&3%vHf7Rp|7lQjKG3q7lg7}+(d5{$p$KwnF!|AVHs->fsgSj5jHF3$Go zE64l6+o862qBob&X}Dei&e4`H4c`)fEgm;3pAeqQf5BWh9~)`z`m7i}3w=(z$Fc9W z-}E$lupsMABBT-Li78 zV6}DysY>^W_4@Ep2Bk;4DhTE_gHvgspYrknRi<-?P|+}n8?2_9EMa*|x}nzzdMQ_K z9h0)kmrF-jP7Do)qZ5~9WqhDK7Ggo6k1j;K>3*kZ6&8rpVsRdt= zOmEwJL5>{LQO;vSX0n-Mt(G%V1Hxa|Zb(T!o)+So+!j;#YB`Ldn{(tism_Dn4kE?p z^EH>W{FBA)aW~)XSl>B@T8Cjjr(-C^<#FAr3qIz_f=Z2-txs!QX|TOi24%99pL{|q zeEziV=HXaSx?N$^5~OiLGpv48udjT?MMEV~t#XR5$@GlnY4cgCdQasPYzg)8%{^K% zIMFHJir(G4DanVfa>MZY7mw=0vm0o^L*ks))m^J`R;2^&tVum(+{5j|^+3KCEW&;- zBqZfRb5|Zqw(ud8ZL${xrq0jSiLXSU9cI{DQ4Ql>TctF@RUt^6!>~hAvi_C|plgzF z`qX34+Igc^)i{0ARFf%5g~}-jz=y>1YUVxeXssCC#?y&vL=Ey(Y>_*6ie?NMDokGU z^%!z(vmBkvHLNF#ui|-Hyp%OH^v}&jwX0#zS|f_J#s@o2Je2doO$iDc)NJBAMG?Ui z^T;0L9e#{{qx$`0y+2+h9=p~$(DEpVP~(0*jCI&zv08Kd!qjOq zc(ZK#BPwZiPQp$Ej1kQ)4kY7^P6~`k&sx2(A^X>Y+gIqz9s6%Y&@f0swo+d|qc6-D z5E%oww=kqMI~gH}AqyW=6$k)4=$Do1;n-{tx)wd-DiuNObP@gqK}@Z0KH<9LcsF_PQCFA%A-; zdS2396ml<;Li?%p=z!wVIoswW%?&$|m=ATAz_WY^Z~YnmP@2Xr+V+HrVB-kM??Y>B z&9{I*;je2=>cL<_s~Ofmxmj^>Oj|3jn*PRFyyXs$b7Jtp+3;^}?r71eoloRX3{IJuDEj!P}OO58ou zAjJu-3*145>z;Lp?{D;URz2T*vx%tA@##&w8W+6PO7X+#vE>EinRsX5;%K&z`|SLT zc93pR4rpMFWXRKF!zj*D%>*A32faL}c}}hNT?ok+LStKXdwwg~bT)kasULGU9?+&; z(A1{=eG5ZecNPk**T+p$mxOhyx|5;NTgOvgzZihYWLTZl=|wMEn!17YG$u$}Teqdo zgZ@t1EbY2(46oNGe;zcaDmsd}Bja8{t*JG~dc0r;yCN~l1uq59qd}`fKt^bI{6X2> z8s0Mg@dZ6Zuue3@|KNORL;tEH-5=p+c01eLa@T~u-DLEjzux%jS2$~b6kFFhwN^xI z-)2Qzy{;ux!)gs;JB*xJ#;QVggU-yTX1%vay@!v;@y!dhT7$=no(lW}vfRTcvt1w5 z&a!e^E46V;cH*$F5N@Z@s8pSju{uc{`EPSsC7Uq}jIJjLZ}&%J)~%84m)p;#CcB&0 zs>c1Yi&E}pW)jE!;*u=L=fEN{o8~$*WOJ9B=S3TzoyfvNN>WX90JWyE=c@SHrfv$4+Fu~*S z1RTcTciF;f7G$Uw;NvwpE}rVoG#AIqe4$||e;A>q7nZ1o?YHr8`-UvyA^@eRq-1~e z13{J`W{`m&FmP>HX#X^XiY0X;Uv%r&-K+I7&?Djwa3@dg>&bhQ3)fx)I-n7s)Vl3E z&@wk^Df#h%fz2^=t}{LJbvqAcRXoN*Td(1C#pyoe1#@Qi{v>av18esVYu`cP(_o{R z@`Y%9nga_74D?03ribQwZ`1ol>U4a9nao9pH(P^<7H=G_gJRFQ(2zoko7>W?$Uj3V z!I5_m+D|?-NTw}Bb?x4Cd(_EM-lHZ&FTK92?_|{fJdNk8UmQ>IJ;~Fm&RXgALth#l zuGLu%y{#g^xe$DyBGedqW?i*DV~?U9e4wk`R*c59Jii<n1q-N{qDOO_6d-tND}gFyh$lqP<=G`aIGf`2qS*X5Z1OVC+@DQKY-smjNCof>%3k z6CQ?jXSpBaXTxqgQIqxyt;hpZmCKr*)K5^vj|3xz+1%qbhJ!XF*TzvZ2a5^>w=f zQ(;NB*)_JJ>i6PqAjPPQ5_Tjid&77AG1a&8>?CDSEnTgaoRK}kuXGd43Zc%)OErUL z$1d-y)h7WbE=A^B+y-D9Z^|QMg!#gWrmh-QA&b^-9v_Nt@ADzk3R2Xix_XH>^cy8XG;%*hJl zpADQTmBk8_#23|cm>eP`?M@7kcF^dzRxe$*Z}Mro@VzU0Udl!kZT{YI(4kG5^4OgKQejFGh% zqs17sI)0tCYfLfGc}?jOlpcy-PJG0X3Dd*Zm#tL!(n2KMEP`RYhBb?o^XE!H{W zhnj%NJ?mEu-9B0GLL!fg(WXtsP1;sEO~k=G%&~PVQ+`f7>ygA3yET5LVc#>G+ky)G zm#D0ukx#{+|xsf&X!Z} zS^^btlaLy4yVH0_rs}$GbvPvJH?$CX)2*rGReNe&7?=}3pGGGEziWtwj%rwYiw#9Q zX)sMOGiSm$HxMb8K9cRhPeKLvbl2~eTXuMgH}|1fd<2!eoCxh{RIeiI0ihryvOc#^ zY=b6*yIaZX9sDBhH4{@fg`mq6RfbyL4Rq9#Giehyi-MZ-8sc^Zw9B1;oVIY&rIjc2 z%v{}Q*jrG`BgHx1$#xVYuWS~f+-LowRBvFW(*@z80m7lFB zs}n6GUQ0?(SsMpd^8}Y7m0eDFD=n&0MV!aM)a%ltzp{(-BP@jCAN5-L(pq~j6dH}= zoH=EWU3BcRtNm>Wc&uS#iwvg085L)?M%{K5>#(l2;PB8{ zm{=@Xp@soe33jjwt1fh8-f;KU@!hfpxo7QVKoCVzKM~;xDi1FQ!frvN07EB7nWqrd zB78$GV|KJ>p?h;L;`p>=GuvdwE1-k-G&ov_pqC_{0B;+aA+W|0mmyu_8t0&b!*6X$ zi_ya3xG}zDx0mI55Z6C9Yho}sn0^Y*lztWoaSb+AqM=C`IzHm}O(O(gMy{a<<(V8m zdeF4{$imN7o^e7?{JXlk*3;9|c4sF*R8kbBqcgBEqTexl%!>WQt6F% zW!uCZEuRa}uGxMVFbNB9$FLq}Rar1Y-AB@T1JXBtW{$W_X1Z=)s~nIH-YV0>1y0TK zBb!F|TbQd@u5KW5Z$u5W^?SzRpao4Ms{%rmIuNIw?{=Fyy#X!^-te~=XQFA9Dk9;) z6VQ-o61I`rV}_>jm27|uFomGAEnPbw=eOL(?kjK8-D4N1@;07QP@Zs}uAv?3&sW2E1li!O3T_swHt*P)8)VNew#hZiXas_E3VmBTwFkOdMpZOw-kB8dGe+pK`7F!8aBk0#g*=G`Yg_OiuN zru$8CS&h@TC48W$1+#tiG_J;$D#;5o&%9WCl~00n*&C zJ@72&XR6xth?6)90#^sL!%@`F)mW%vlq|MwX4%V)l6tis z@xJA;i59DSxBH0T2&LA91m5_jTq(PmJ$r{{h&0h80AiW zQ>%SA*jYTX9{?;ATuGR*V2*gPBNlDDcBpQ8gW1~z6P=nH-djL%k<&)+qtR7Dk}Xwr zf7$&wW=rSygurzfAjbSK)9r@XZtgtqI)t9weUpo@y8_$VFBMfA1AE;a_7seJI{(}b zEcwUk12er9{UVeu(>dav#|DPkZ7jnJU>cOsC8BGt!t!Kiqyqd_M4x|DJysXU(Hsz(s z_urPMYgia>) z3?7@m?G@VgH}We3SQB@Xb}4{~+LEDLF+K*w4MZfW&)pp7DVv@TGEEC-@*fYtK>EUU z9o5~?Hxg?T+<)X;*}{CC52Af=Gh$%_^oVs|SNH`d&h7^K>~#`*&&_FY3Ns`}h=t5{ z&*%<`mH6Ta>D*qW$qVE+f8;>vCY5UdfNqNDlb_>vx!7JHgMpcwp945M8v1K+Hsb?~ ziv_Yd44QT|(9Esl1{sgF*2Jp}xw$bnWbA1aYDI8j#o&3v-?h>qTu7K!DP0IX_LJb3 zqq@sswbkz0E4!QR&CW7ikh}JIF(U4Yb%qEfZsdCQ>g*IhtJ#M8uDk~}sAl5uln1Z3 zt0_9pfmC=(-I9+u6Q=svlqYK4!*?3|PEy47)LnH@IvE4SfY;-97XEZ7XSW=%h-_Ud zy=?XNzZAsUm$`)#KBYEjX1y3zj`~BKtM~&91xK@@bDQ<#^qyumWkh*2`=pnkoqL&^ zNTlBZ&1mKi18V$b)I2bP=tGmRc2FqEsm4;R&KpsWZkjIW=6?F8=PikJiAiOxeTgeMHR5SC z*p-Cug*>{p)QWn!l9tf|))WT|P&&rxO~kBQ=0(rG#a4ax^dmkp)vnfuhh2`t}1SifmOb1^qT+E;ziwKJZ3W ztrs6nXiRM)UqsPspYC<9Y5(bO#)z7DU6;&_Lg$C+h8=;4OG{8xMLe$$jXj2USwaA%^@O;h-nhLAiSPawojNNX+Qff+(5$qo;b6La~sD zY}fCI#I}&$*jhtuT|K3Kt0Ll))R{1P41Sb=p9K7azj*n#0$n@$B%B7D+@-3Y`o*TW zw3-#tYvEY&K3gY-qN1IzD*i}N(8jAMW7a91^M%(wgC3y(veys@SU*4M-~5z{J$}~1 zecyi0wNR@8Nv$g5fTlWxpML2OXzEsTnbS`Cp32>pHcTncZ71peE0){D;N+4k+xb)= zh08e4y%UGJ=5fH`p0Dqq@p~u5C$!KdAp8@1?d!%frk(mo7}oq(Yo5p^ySf_*D%vw| z>t-tF2apH|r~EhZ=PCet^~71R#um4IFEifAxnIs?XQ+Q-pW`__JXW~rr!Cb+rb|SF zPIV+W!S*VA<`JKZN#d^m^5;waBGyQP8MgYS5bb(&;o*4yT+TaCn_Uso9k^F$vUYzu zLMOB#>>Yr6WT80Iwoq59%`fL_Lp$DuHa&_U*p&0g)$(DX@}lqBfrJ&0)R$ixMIPY? zFT9f*Ud{VIP#d|rKRlyq+ktzN)FY9wmqj zkl#+VcK@&oiLml~=~?ZBM58w*WV`r=_G^-am*y+eV2r`*MAlS6;7t$)9zwjabnOmW z{XD)=61?&H?0Q~@XySx*k9|F8G6B~;Fv5c7D%LSEM5gb`JTJ^iaJ=PkZF~^LEuJ;b z7}%&Z`aD&$u|WdXLF&p!QYi|>1v;Fi=I6d?`!lRKT_PaIEF3N7zD>%Nzr5)dyFC$S zzmi~00mQj-A>XN;Q0yh!%g1$MwxeAHMjTxR@WE{sZbst&v9OVxZjG||w-u&-byc1a zr7yB7TC3yy_x0=RhQ@34kh6gHl^OjrqqZt9hB8aiVy!~`w!J8yFO%)2*zh#aOj+$e zDF!TJaCxyOz0HPSL2t>a%_p@6gsN9IZULEC*6w5ThofQ7c$KoxhR60iOuIskmf!l* z4impY%StLFtzC(qauEq&!Olp46zF||p0wnJSp>S2$Z&Y*`lPe(SVis+To!RnWYncc zaMwu4Je%*j^rdnc-t8p1oy!{Qonp{(`*wAYjznD$BpY1c>Z|jaQa$8D8EnlpUQhH; zOmh#ttk-5un+aFfNmeauzF9BRlfJG8nNP~~>iA$*TP|x!mS|LlCS8eg{py@Wqb91P zs`TcqhB(XXkD#s5WiP)dn`gYzsl&hB*!am&$(Mq~o8#1AX8Di|sg=t*!iU>;(p1sy=N4`_D8Z)-fzvVhHIAVk;4kMzaf<{$jYuQvSXssqYIc+gn;-bgs$HvcmSz z`#pTw+c$|(R_@z=FRuqn08lcfJUR;gs#Vgzo1dT>75&f{Vp6{z-@iuO-W*ra+B!t!<~9``3&pRi3T5S;adzxE{jssUKu5cD*KVwGXv5FVt* zYZ#f5j4)u}vVr6#fF-rN0$!rEN_b~@0?S_DLvEHP0`-c%jZ2$&d&6uG^<*}CUlqzF zkfs79O!=f)Sln|p@t}i6jb5MR4oJ0D&CqC=IfOP~cj|es9WPEKklSBzJ_=3PBi&P3 z@;JAVPT__S@Z{_188_DIeExG=PvZFuLD_c5F@htj>40K;Q)fC z)kPE}Jl5WcC8=UHkVgNYtuCsz%A!+R_L}2GXCwSb&IRPE0nuhL)c%6VuKDj)~*oAlc^#1Cuq+(WWePndp zc}S)_-^(apZ%#4ck?m^bnA-BTxsH5actE^P+KhPr@DrmWw}Kr55m?cb84YafbiUr0 z7d8H;lv~d=;miO{^i94H>XdIeO^M6W>e9~j%{(;uMQxzb(`0&n*eNX_n7Xo|2{7s; z!|~0IqDQk)&><6^*=d8)-Z?P26gK$HX$@}!40*#F7ooVi$$<}mQ7Y@h&K5@^96FYOLDQ0!#-Y{q?_6=)A4J|YFrd};)}aDv0lpsh9K zJPb&Zrx_0foVNfjw)HziCbt?jP{nve7#mo;mrn6WT{EAQBIm7&j9(4wcvdtVHD3%x z$9kEJ-zPLafto>_(-2!uYnSYaLcn*0f{}#utm^8|t+x+9v&k=CES?b}eYbt4t*xEF zaNRI8Cap%}1C-93)0~Q5wl1UHV%{+Fs7D~zxlTI^#uw$AT+j8|1Y|LYi=TC4XESt) zh&#&*)U(eVHMF5C3DBlU4s*s^vS5yXYKAFD`KiX0ai%OK@pN>p?c0-%)9lRDG~$vn z{eRf1JwZYcQ&PfITzKRa8XG+N`t&o18Eylx;3m6J>R+uQwm_UNJ-{^^&qH?)m8uTi z{;YIzPMQg89(>iF81c82mlA%67930(pFeCER`ayiG~m_khIs(rky9s6sFK#*4%teQ z%%S6o0#_Ai<+8uHeELXf7Rk;TG_vBs2<#n{-OZ)4j&-lt0hw!XJMJpII*Foa9Qp99 z5*#=z6+(NX9-0)2NXoI0A4?s+9=0F3W;Xka_Q)FV-(ua$@4~GptjGP9ZeA|4jYe2u zg)onz(kai+*D*v`ffY-Hv~N!iX(0w}Eis8qY%9R3LyxAdZ1|Ddk<<(B+T7gCxPREa znG!u#=VYWO4T-=v#NMob&)+eSX8S-mIE8TT`7o&Sh&VXziZtNgBy6?p3+E1szjacg zWcoGkkO>2WWLFaO7t*DOk4r(C$?yCn?=iG1DwgNIw51tBfGnV|aK&OhY*0(CGi;oq zR-Vw1_5_jfOTXdd;N&0aB;sj5xex zyezyzJchqefy%_Ykm0VuWb>YTW%Qbr5Jo+2$1nOHYpOBqBoT4{I~v1@VftrE4XaR1Kj~(Ls4* z3As7t!g#d4bzt*7EJD`W`!Lf7%|EEP!8wlXw|L_+kbh8!&5EH>t03g(mqSco6~@#w z*Eu{nD3}1ypetbU@Wi@2qiL=DU9A3JlqY9;iI4^8*VhtSl3I0R;14G(sJ`yHH)ciR zlO3v^)Y6Z<-O=ADwZwu@3*n{5uX3$S1M}$i(hHc%1K~o-@rfI*{Mq?EgRJ~ zs?<^+z{{f_0dCRY-<-#>6IUIab(j=qP?PeO1wBIl_v(qS6$Qji7??ffeUL$9TwhMw z6?V`eV!BY=np?Zp*YW8`d~A~Cx*91F!z6|galUrwN`Op`j^YAIrxS!O#OWZ_fFSaC z*k^ZlU?B!!>2GoE`wv1dZ|}I|+vMuz zTJ_|dmLN(72&eG0^C-y6`z7od{foR=>`-ENbFYn5xW{Rc_M|k{YFD;}t)3nmCRK{%B1^DaRc>Ku4T2~8`? z>w{p;CM@^Q#agE&8j1P^cl^{%1`sbLlxi3p?}iRLgijw*|u$W5#-6 zbuoEAH;xepKH+gB+nO^t(ljYKIb!TCk{TQ@F|oNToABxBr8-g}2&Y8)kj9uRH;q{b zUH0og7~!Fjz1#o4xzLiqikkn`rDIc_Jz%P?4Y@O#mt?XSf$bgVnNRvj*LF z6H%_4n;Rg(Cx)i5?r3lCUs#Cw1`d|9h#Q-pZszzN;;b%Kz6e3N@r5F{r8z;?d|->0IFsbOty3ZeNF!)DPdvOc|!kIw)2(TB_lxrP=>vUo*#_g z4^P7X6qifQ%+Ahb2ha*D`$|em&TYB<_`y=Yul*L}s3|+I9^y>vd0L1M zxCGOIXE!=DwWOLuA@wu0d-RjCfZgGHk&z-J{*&hLgylL@|J^6wC}^;`=rZJ{qv#SD zxW7nk*ZlkpC)n9zCxjJLPCu`SJmXlei@jS@slOWCVJi)GW1S5Y=|8h`z z8Pdi8WSO{uY}IgO+DyG)dQ2O`%?Ao<+%Aw<(ZEi%n`ZhUwr6(JJUTKY&mS_ckKdrb zq{)AO3J47lgi^@}g1B^uYCd@dO16IYsw)Fw#}a`2Gd-$}0naEkbg0^hIQ%Vu$2uYu zkFJwY?;TGy#Ca)L-|~GfH;4jGM$|eYUBJFt!dnl>+PUBXnpk!TJ0`*|;Zfsqt4(PY zdTZYuhgyE^F1t+VXggcbFgO5ie1`rtSuYLMU(3kKH6AE5Rjh<5{BRU>!Rx74E1tGD z%=cGaqp<(2@N;J3jSI5uPX4~%QEDoUcHW*j`ZD?4$BE6&kCUgR13X7M8k~a2fR@NX zv;s;l%glP6C?JhhNWiC~L1bc}w-@}_Jh`6kwf=Gm)i>?i*T;_!(E3dYQQ#v~zH!+K zwI0YXlNtVi-(&x9mTGx(M9mp9YdWDinS4J}DyLV6U>&r#C!ERs=k%u+!@@y})ZCoY zksEkqkf^qD2fXpZ^v=%BItf{MQ4vZiHn!bjYp#1ON?yLsjKgT{zT*&=Rd02^4~~}_ z%^t>qh1MQz+nuiXdSae6(0j{#E9ufXtzyGsviN4x>6l%!A8=MSW?8Uzx#;Wn>$9pw z&)^MGc2N(!9&t@#O7_j=4eJHD32|5=Y{cNBCaL&sFfzlh)^wui6s?Wh>8jHLpd&Sr zo6gS3Z@N2?KtDVzaWuoKh`9Cc!V}yL+`xAoh>N+ckM+kNO*ijU4>am&}Z4lO2btf>Iem5O}EPR~1uWg=qd%a{N zi3{)T;i#xB3j|)Od;<6}0)5_d=YZr}R#sM8QnvD*(TLk<2ht%g3=4*La6bc5U}MtU z+)&g`PT=eOy zJ+PK}uxn@+7?X4a*LQL|BOHxJSe+~{98=HI%5|72pQ_35fW z6{_=kZGUd!ndDNRKN3g3zo0MIZG|R?nn4Q-#c390AIN|>@ZrYDt&sAY=t1jS?KsD+ zC(Crs6oRZ5t?C49_<+Jp{YpbKCt4_-lsSpYgE%CeG9qG+|3%LJYv!xdVsxpyv53qw zH`~Q}xGNw+Fhy6YOz@-|f2qbD+67NMP^)zV>vfRmYU-wf-2v$wZeyJbo4{%g3v%r@TcmHB|*GF}-lD1XukP6nF&!r`12>*_aDLVegsVW&V93P*GJ4~1@Hqx zi`$66P!(8lRDj1@7oAp-lJ&nxVwLUXq-Hc{HibDlxvWBPAo_U1P|RA+=j?n*v2`W-P^2A(}5LI)=zE{1j?n(FC+=SH<1h5{cI;e zgKfaC^BSazM?>arX-2Q-h{k*c^m1y z{@ndwYL9EM$H1_Oo}U@}#nu_Eav(a7NJ0xCATCs6t%od}4@?Wxu@2q>9N~$16j5%M zed7Wc?;O6@&VwMsPVH}@0X`k-}xXsTd|qES+WgOV)+y4d6k@tIGfCouFW7(a@4_xIM5W& zviZfjY{NY4LU0NzJ4R94QTTHmlhbspRLQqi%E#B!$|D?%74<}>Z#*0-jQ zO@yDoi#sm_N=S?8L^pcwrgIq;&o9WNb--nf3V>H0f%`}|wJlUAg^cWxJr1Rvn z20}>8fX4e~_}tI5aLb8hLvm)! z%wx|?y$ogmAh-UOEavl6k1?B#_cb&P2Ae{;0{kl^kOGEA8@`-ho#@E*4#_4!+R@Si zb24t7QDf8g^WX&pM31oMZpM%Jg5K*7u}lDH-5j0c`|EDI{(tfR3`@ARG8Tnz0SXtpeO*_ zY)?vDuRYJYuF3x6I$dk4!dOF?=ZSbjBWIpBUw5VD44@{l{&3u($Z{`QSy=B;oG;6D z>T)Y!;Y&LxgYEO3iO4=xqR?n z?}9pZv`luCKbb9LXm+@_@kn$QkgXe*R_i^eg%qSlejV90y?<1y?Ga1O3Zc6U9ny`e zD7A7)g1{K_Z>h0Zn zq(Ow^=2;AAsaajL z2(-HW(0o*dU6F~B>@AqNXwr(qxOeN{ojce2d4!Biy}0Ih@Xo)SW2`L5%ct#q5oLbF zUJy=5z$!>{{Z!8WXHjj$l*op}<6e2eb0c_A&2o7ndz|D5Ge>OTm;fa(cgda@66V66 zDBpMumqhms9xB9>Xn#>gz2?VPq?X6;dCrUe9g|y=yDyaYQygd7oCH!Gqg{w`iDEhI z4ABEEdd9@jczs?4b848j%%;i%o+u{#{Gjatv(=6g-!RH}!+RDQ4R<0)>In+YXH!l} z1p{12Jdyg7L)drU36d>})g)G4`Ms=6uWSf=_V)HEh{-3?6?JK(Uv@21zHGoj4r^5( zt@f*Dr63Ajp|mmHkO@#A0Nf2|I^nHX5msU-IJ zMD6kgF^PPVdd`uvB0TIy1EFmd&%8|wCX)0<6Jc87##DdWWx9txwehA zVp+XfU`Fdu`w`K?p&!x*xvRG^N^95RR3gO)Ga6JMp2{pWuw#gJ+O2W!>y)J!oTf%~ zU-(-0JerR2XA}Zfeva!=P0q)bFN75-SUCA}!ylt*H4w`yU}~-!Z*7@g>fgHlzUp?R zP=Mh@X@#w9ti`G9FHU{!Loc>&ALliO`Cy(?Kt)iCP@5A&lHNAKgud?M{F;m7r}jW$Ok?&q6G zaXJZ%e&RPkab$DQm<-#xl@|1+k*b7NklUh4{Cmm7A;{hF0Tkt-!M^BzIw^k7#k}73 z_x|{o9Lht=hjQJY)(c2V%$b&&v;srt>ps-qZN)Y zM-H`7-PLw?7dsIwxcg#XBk-SG(dOk(JzHt& zL-5kqZRx|9_%jqbD8NxThh}c9^Kh1gdXU=gU#QR4YGI{JXq@FrVXa;f&-_tXVIFys ztTrMtEdN|D*c2No(~>+;D#DGQ1|=uHSXi+JYDP9;wu41-JXa=H2^Vi(yfWix$>D4R zraMLXzp)p*lmI!Fh0a5>;{ADAH?@qxD?4sILT?I_GM}&T5557Is&WG_5q?BX3q8Hg{Bc^3M&BS>1}?_(y*^ zlDJP$pUo2;?dO-JuLU-e>Tmm^(&V-}wZc!TGWJGnpOGUFd;`c$rbnW_=U%^)kyX2s zLLsYtY;b`a<|k@j2zYTAz0JUa4cM{L~Er*LaUevR$5anIK3K;lr)8u?zAkqWT3tj zaTLq-wZZ$RoUb@|nsf8Pz?o!&^Zo*Qj>0a}_9TPhLxf|!jheABiBLzENcDr-*Jye3 zz$_<>!U~B-gLz3Z{z)|2x|p#xnlp0|Q`-m}$5Sr;r$%Pmi0TtxS$#F^@*S@R7=bE> z#9?ussM1G*Wy)X3DddKSnpV$r$T{GHh6gk=i7wyc)0cvVbkXV>_Z@++TJTs(3_IW> zR>O7l8;p86me$MUmpk=ND>i3IOLe#)@KDB#!ywc!*)1ZCgV)+qX{^pA_`atx66k%O z+sy|ZJZg@~)yuY}BVQz}QFDD0D33MMQO(CaDf>8iOm|%rz@lvx4*JeF%qc-pHXtS| zmV@Djjyk@FN)@_lvVj5nocIQ(3f|a&r0_9MVz4(~QIkuSq7EOG(?Jc&p%vhQ@c?-# zODMI&>Y-Oxe5SbGn7C5ULURgHky$LPJv6EM@zTT4#3IO(IDf{W4#fugKq3XEm?q&r z5+plaemO9cWFN0tB*AL(?5oM)IVGz(#JjM#_Um@(gY`u32jC$yp;P~eRdj`3m*zpe zZhmR=Ft67Z6B~Rh*^@?MSyTgP%el`GNjbv@{iss7>fqPp zYzIb=G4(%~k6nyQA@U@78jUTL2`b7tJzKgYGo7T82E`*pe`kpME5olk)hqM#PSGj1 zU}<+wKH??0@vy+3vHo_JMvWkd$$^^J*puPiJU z2|XG7d#a!O)Cr`vHK&PJ9O5(G9f4RZsr_V6hb^lx)};N#Aa%L|m-eNwaG7KDlv7)> zk~G#tN^PAwHRf_mwETD3{7iPdrTjaGGwkxXmJqJ~lKWjdW?c98iDiPS^HW>NjvYRIZ+{Vf%GIFa~gR=3|SlHj1uGMy(m_!f}=G~`+|jSu7gPJ;n<%wx*I~)9+6rB zt`h`xN^4x;uI3a?t3P$}4QFKLW_oNg^PK(5wX3oah?M-!(jsw$gq0_8bhakc+KWao z)1PgHV5XtAsK=D36}sPb+_C{mqR&zXA;%v?0=Vsx>_@Hi^InKI8wyjTeRIyc& zxtZeE)waUlQ2e&r`sKj)BG)_6%);osjKed9I`lEwIi`bPrM&-4`vF!IG?OkHuLG zRMz_AZPri9ESAsn?{K{62gl3EPM=28kGL8jP58V5k{I+fTfD9+(Ira&s0t+h>9!~& zGUqFs5sR4wVg8-CVc3qB?FZ038Lztu@9oo;Z`#s$Trfg~l)kpVeEgmFUV$%9P!Ha= zirH)7rs|GB<3sTT*t`B*zTP$IPp|H<&_BkouzXxR8R((0oaAT!VcCG{qc8VkwidVg zV|%e`%imp{*B#!4mq&GZ7yYco3<3<=p!;c&G569i6maXxGY3Z5^o0JA`9bxdt$4%x zvQx}Y^{gQGqdO~8zI7n!<($zV;_hg{m^k=bvR@Vhmop%ukju4;=@!6B{wY?7yh8P7 z;7&nnh=>MIO<`D`G9`wOO!f7;lhW6xIU7pZyLCM* zOtq6YWcw@?HwQ}z9On-kIS0QD@imjM_ljhczE+odt&=P$~rA=;=n1$Bn(ruN>Euy}B zQxTIGLl=BqG9=d;$#om$9yTM_8S(x2et-S({r&wrkH>kO^T&Cd$NTX(@5keu^M1bG z?@|`p=X21TjxL zcjy&3@vusk<3pG;e|T~fy?TA}WS$E%WW;;UIqtf#Bqxtt9BvTPnifhsSZ{Do-2wfe z<;YpDj`NYz)&$$Uf!_zq=SvINC_^_C3dMV3c=2KMF+^6jc;DQF8~XDBsfMT;I;*TC z$2<7!aBg$O^_}>QsNA5>Z3-Bbm>4nWm}lUp665Wt{NB zdMg(H44uHb7EwG^+~|{PA5@C#s%#S_6CV%k6D3)ABTU$5qB6L=pBJ2SKJb$F2$vAx?sN$;J zgI=;?HEfBbE~=zQc2FQmu!mb7?v#L%Uy6vpZKdFTkr2DZ+$9#Nmc<+#R8i;M386df zuZ*s%jMI5A6Z4)GOL#pHE+h8foW3^aq6M;Mb{9AGaExwD`WaST7&TPncP*deUVxZG z-B#+C2ggRF+{Jx);?Z!rSFJ1UQDlP;ihT=ttdJHVR|#LAyxnkV!U2&MKQh1R2c$hp z=UEZ=I&oyD(#`IZ<2RKIH4nud3DC+MPNDX)3NB4N0hj(rs!Dk!JxziX`dgS+*0)1M z7NdcyHnZcscumK)-QQx0N<~d`mN&HgzQJ89L`^hH)nxnAb*hPJDZo3Iiy(a}TM)(q z;r$`kQbuNX9lw4f5`RZ?qydf`#ur~x^gkJq$pgaoJfsBS+VmRq8yN$n6#_{Cq2~#0 zXQzeoyaZoSuX;U0@WZXIMQ|zfN+6W7#mloLVk$k!mDKLEY&?mQhSYj+;x{H3EJ*px zEm#SQGmnlLX*hbyre#YpBRYv+S-xZxtWD(b2|ur?5xqI0z^I29OaZZ1r*zQ^%*<9B zXkD}Wy$ca~OGg7A7P^pEOk_ghVsB3-&yAwRGBW`ah{24+mH~%}BE{?AsMdLEAe@0H zaFh|fNKA>ZN-2Ct?8_H*7zK5)iMF8Cnws%gtw69Ki8kfXsb=>XMV&g>6PwW;qNTdX z38;fD*!Ih=qSeJiG_naN?ll%*58T_;re$u_@pc*O-3Zs?ZvrJhRMYeNMh2qWvgmD2 z`L$IkmoH=c9FE=;B?TYy6lR?u>H3tvyndJ7-EEeXe`*q7!VE+jU=co|s5-5BA?KVo zaE$kpEor&Mw@h=~!LI}z_2@olV(Fq{*{c_JS>axRv?Va3q0o zu0H5aNOXyhUt7Kzz9>KegP|MxYCnJjY>IS$hfYwJ(t)dvb7HoV^5G{3w~-!i-y5|< zn`n89cg3NMt-4)4v5CCc^5AK%+VsqH2M~n~JAQs>=FH1#Hx=<&8k*l67R7|-qsWi? z$V1oRnhf40!%zvc;MP#J9HC{nwhx~8O9~$wI z!i1+!!wU=Tj@sjFnri(axJPJimPu-AssR)opP0zZbiV&zw)f{{spyJZ17J3$`F#y% zL#?iLgK-t=6MzW&r=DlNNj#QNUcM;*_*u*^)(F5~84R7ih6(M>>C=ZIv)oA!I&xTN%^b44wh7?H8wP_~I2YL#HvD{SW(`)YE^#zr9>GCK|~J zfIv*CUIe{iMli+zI(saoK?N7JNw{K(ZI`0VP?XzQe+yv9`>S673>V{l+;mKX&nlfx zo|(0wP#B!Kot>Vrbf3ACVeW6e+LS+=%dsulI(kO0`K<6pX!w5i3+ajDjdzU~YIUo! z&x4g6W7pK6zOQ!Ju1RrzE~j@1indV>X0&DpV?68tx4)q7gx#l0t~CBv*1bR3A^79bvcud%&be76LLWsNHYMMZ_-z{Mlc#qG+RmfKbFj1 z2D{SoNfwEK_hniB5<<{$_)(mHIk-5IY79w{r=m [!WARNING] +> Do not use a code formatter, massive amounts of line changes, and make multiple feature changes. +> EACH FEATURE CHANGE SHOULD BE IT'S OWN Pull Request! + +* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes, document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in denial of the pull request. Additionally, Any code lacking sufficient documentation may also be denied. + +* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented. + +> [!NOTE] +> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace. + +## Walk through + +### Fork the Repo +* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your Repository-list. +![Fork](assets/ForkButton.png) + +### Modify the Fork +* While you can make your changes directly through the Web, we recommend cloning the repo to your device to test your fork easily. +#### GitHub Desktop +* Using the application GitHub Desktop (available in WinUtil) you can easily manage your repos locally. +1. Install GitHub Desktop if not already installed +2. Log in using the same GitHub account u used to fork WinUtil +3. Choose the fork under "Your Repositories" and press "clone {repo name}" + +* Now you can modify WinUtil to your liking using your prefered text editor. + +#### git +1. Install Git (available in WinUtil) if not already installed. +2. Open a terminal or command prompt. +3. change the directory to where the fork should be cloned: +4. Clone your forked repository using the following command: +* git clone https://github.com/{your-username}/winutil.git +5. you can now find + +### Testing your changes +* To test to see if your changes work as intended run following commands in a powershell teminal: + +* Change the directory where you are running the commands to the forked project. +* `cd {path to the folder with the compile.ps1}` +* Run following command to compile and run Winutil +* `.\Compile.ps1 -run` +* After seeing that your changes work properly feel free to commit the changes to the repository and make a PR, for help on that follow the documentation below. + +### Commiting the changes +#### Github Desktop +* + +### Making a PR * To make a PR on your repo under a new branch linking to the main branch a button will show and say Preview and Create pull request. Click that button and fill in all information that is provided on the template. Once all the information is filled in correctly check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good make the PR and wait for Chris (The Maintainer) to accept or deny your PR. Once it is accepted in by Chris you will be able to see your changes in the /windev build. * If you do not see your feature in the main /win build that is fine. As all new changes go into the /windev build to make sure everything is working ok before going fully public. * Congrats you just submitted your first PR. Thank you so much for contributing to WinUtil. \ No newline at end of file diff --git a/docs/userguide.md b/docs/userguide.md index b4ef638b..3f1af23d 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -31,13 +31,15 @@ * To enable tweaks on your system select Tweaks at the top next to Install. * Then you can select what tweaks you want adding to your system. We do have some presets you can select from at the top you can see this in the picture below. ![Tweaks Screen](assets/TweaksScreen.PNG) -* After you have chosen your tweaks click the +* After you have chosen your tweaks click the Run Tweaks button at the bottom of the screen. ### Tweaks Removal * To disable tweaks on your system select Tweaks at the top next to Install. * Then you can select what tweaks you want removing from your system. +* After you have chosen your tweaks you want to remove click the Undo Selected Tweaks button at the bottom of the screen. ### Essential Tweaks +* The Tweaks under the Essential ### Advanced Tweaks - CAUTION diff --git a/mkdocs.yml b/mkdocs.yml index 53f37bf2..42db34b1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Chris Titus WinUtil Docs +site_name: Chris Titus WinUtil Official Documentation repo_url: https://github.com/ChrisTitusTech/winutil nav: @@ -10,6 +10,7 @@ nav: theme: name: material + custom_dir: 'overrides' features: - navigation.tabs - navigation.sections @@ -21,8 +22,8 @@ theme: - content.code.annotation - content.code.copy language: en - logo: img/favicon.png - favicon: img/favicon.png + logo: assets/favicon.png + favicon: assets/favicon.png palette: - scheme: default toggle: @@ -35,4 +36,6 @@ theme: icon: material/toggle-switch name: Switch to light mode primary: teal - accent: lime \ No newline at end of file + accent: lime + markdown_extensions: + - admonition \ No newline at end of file diff --git a/overrides/main.html b/overrides/main.html index 853726f6..f74840ca 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -2,7 +2,7 @@ {% block header %} {{ super() }} -
+
Announcement: This documentation is still in working progress.
{% endblock %} \ No newline at end of file