From 0c389f56bb470daa17ed7a5994c944b336ba4afd Mon Sep 17 00:00:00 2001 From: Ryan Yeung Date: Wed, 25 Oct 2023 11:35:33 -0700 Subject: [PATCH] Updated Readme to show latest/pre-release toggle --- README.md | 7 +++++++ .../doc-imgs/read-me/versioned-docs-toggle.png | Bin 0 -> 10394 bytes 2 files changed, 7 insertions(+) create mode 100644 static/img/doc-imgs/read-me/versioned-docs-toggle.png diff --git a/README.md b/README.md index eedfb5dec4d..4d0d7dc1461 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,13 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +### Structure + +This repo has two main folders: 'versioned_docs/version-latest' and 'docs'. 'versioned_docs/version-latest' holds the latest official release of our documentation, while 'docs' has pre-release versions for testing. Switch between them using the toggle in the top right corner. + +![folders toggle](static/img/doc-imgs/read-me/versioned-docs-toggle.png) + + ### Installation ``` diff --git a/static/img/doc-imgs/read-me/versioned-docs-toggle.png b/static/img/doc-imgs/read-me/versioned-docs-toggle.png new file mode 100644 index 0000000000000000000000000000000000000000..77fe4573eb8f2a9839e0671b8a37f94c4f697fec GIT binary patch literal 10394 zcmZX41yq~Q(svR91SrL!xVyW%6(|tg-Af_36boM5r8uQn3zW7v1%gv3Rm;e9(TjjZeHUIz&Mb>R0XvlBN^7vw8 zhq;ryJXA$qo(Adxvv+!B2LQ07cqdD%bwdezHS4u2P!$z$ACpz^KBP|;=T2hk?c$bb zAJRD)6EG$u2`GA<5s1WGWAqp$bJ6|52Fu3Lusm(SGOFvjB@?V(3-7*hZ@Ox`;2S~%@mf30+vi=q3E(7)y@r3?I>p%j*1w&Q!zij4sJ>9W zry6>lB9a3etY_jPCAx4%lL~t8$i`FMl=FwlgFl4ZF?;jHbwVTOjq`~#= z3{~va)d6hCIs^cWb^?HrH6XH(AqxP2k{Sg-M?Ue9MWG1vzf@po5z7D80k(e!%Ie6g zs34y@HXe3%uAYuCFCnvGa-^tfCtX7?L-iM8HZT`1D_fYg9haYr+g}!dgr69)>SE_* zMdRo4%GFcMPm=DR5n{;t-)?R?ntz6PIZM(RszYhyVIFogLR>stJakf+G&D349=7&k z+6qelW=FOp=^VYh+{C!KeSLkoeEGRx9uC~RqN1YQJbc`Ie4NM;oSy!!URHjbuAcP& z67s)t6zn{0Je=IToM5grf8|FE9{`oGV==4t2W^dC*Gp8sAJa)I1`DcrnV zJly{$8_6p1w^t16v(ce^LHl zPCZXM4|$jiQl*#Fe|F~I%>PaNH=_ji-iPi>gD?Vh6&oJ1f|zNOlTjhKkN|whzyMnX3Oz(BkZq4KSUTq_GTK=yU=t zs@0*$_78smE9>`ZA)D7qh(o;R>gvECiVQCfpt5&Y;373p5wC7W%x@(Wo#FZ0x5^9D z90gX<3YH^zqAq=H9-D(gc9$%E_ZOR~>Mvh@xGRtjX_uTO+gP3YXaGyRB#Y=f>zX|Q z?%<`w2Q^z5FAWT{Ca|K+9dfVjKC`tg$>w6KsmEIb_h=k(N6aYMtj zWj<$QI2v|WtySgq`Gj8Ta5AlYPYowgVc=PeQG-tTQdDZH_TBY*lD(7J+ak3ru8PV^ zS#NLeTq})yF`~`Q&DnZqgIqChSwq9@SId)=@3}H>;Bdg$>)OkQU*s0rAluI$Cf=(E zf8=%x5$-Lcy668f>1AY+z)&RG9-B0U>51#~ zj&|P|(6Y6+&wj6GppngE&Jusa!oi_S zGIX~!oO}Aqp|Fv)vA)Q8riMnb=sf}<6A|sJ&7~g9%*3?zvs8`A$+Z59=l00;{V{d# zKnlHRu1DINR5!hu%7FwK&_Kq^CA9_@dP7S zaaBYcI0iMssQVpNnHy6PdsoiIpH(Pztr!@*Lz+HA{Fc7H>7md3YR&YN*49F!u_>Vh z<01pt9Ppw!Fg>!vvUB2)%-G(Z$=q+X*QdT-xda9MDO~C(4<8>tLa>p7T<8@d=xXuP zVzIKavenWze~}O=5_BA@RNTPRUJ^0rk9=|T+sniLOimN8L9^Yi*`tDpx)MUbu!YfW zUCQ@?f%F+$3~{l~_-=r%CG+4NYDqLR`Paptn~BR~gS#?5nEujHfKq6$xyru@VPHBB zdbTMTDH61a^jqRg`zUu|DPyAQ#>Bl-H*yu!lUjska`?%!7ieCXZ{+;V@J393MSl#t zis)I6k?NX{_vg*S$l9!3cPknCi(edS+Gw$H%C!2X@^w2zy)yc6Q8iho<)vez zuScC_>bc`3$~aG`rCuCa<4}sdCo;vffWct#&r+g_<-NQFvKZ5)IK=G-Xp;;8^k)8^2U)uc!39>m-n-X{~5#2i3zI# z&UX{z-YqAmr=4-!?eHY&2g8Hwnf>^8wY3l|60V=Dkd^7QCs@D(MM&+4pdNJJq{0T}|%#?Nq6!zn@lI+=Q+8 z!v{7>GEb5}tzPd8A{v?-GA9W_RBeIDAUFFnAA1Ma#Vocj9?EBQJ(yQet4-2LAziC8 z#A6ROhVS>?86ka|#`L-XERQ&xp}>{c69RVs!WIe10t`l;)Sz)q>}l@ox9b3`ra@XHS*USGSupyNzuN zL_F!l=>R=W+%YMpQ7+8GH=at;I8!Ikx;Hk2hK~uNHk*H?v6UwX!kqFCH{hRpp>i-04q`eea5)-`-nv1gBmiLc?iR)t1j`8OI7H zTYX`b&(G)aGhfb7OkM4!v7DY?U3Gu9`6XAGgfM}%#k_d~x!+RybU_4Yb`YSRa8)mP zg00KqY;pLfcpH(D8O`^k0ZhnnaNYK>W4*c$y9nRH?34%^P@{AEX3P?anb-Onka5v# zofRVEkR|zO$0AfLGDNNWt)k(IO`N6;tpe?-V$e;X z6mtm+J;4WSN}M)n2%>Uc_#SOcnAh#taW1ZQllnc}Y}eWk8yhKs3h!=5C4N`=7_@uu z>r31oe1%|Oj5qLSkV^RR#Ky*+jE1zAGtyJ-DF}RZkfuTTsN3$ot`vBGVVulITUxAP z`}RkHq=}iWfTp6fs)C?V+(gD>TraGLp z^$J3^Z#u-rzsjh>)05k7wXeEWWfG#W{bMm%VhCl5U@Ua&MvV_}QHzeC)lU*BMCnMxFW-&b=~P=ZHJv)Fb^dZx*)*HTABKyS!l8^hflF`r;+xd?lNN=kxWN}T1=HI zg`-wugkcz#YD9+LR=wsMxE8+iOH{APo^Qj6^5qdW^{LZEJBELCTHv?)mGw>b#GI!@ zVQnhqT)(@RuKjN53{Gx^_VpMP6MCC^q9amc`cKuwYquBrm3-~R;(H?LHXNS#8?l5L z>UqaCBs%70Ja3waCKf+@oyl!cMt_iT4H!2}-KiTM$rm3^B_`Y{prKn;D%TGS1KF8S zQ^TrJi|ornmM6Xc+@z-B->u?=fSU^khULTZ!HZw)h9V2U$)%DIv*m_OPnVY3{ls+Q zbQ)%rTS}&b?(NKL#SqRT&4KgXN}b4766$vSV=BlxtFT)BV>?TQ z2+AKQo%8xq-6oyX2?1ADq1;!ff;nfk#MI%WKmOVNmxp+9G;RfjH+^(0)$I(N00%Ze z?~H0|i19()dU2%svaXUpn*j$f7RPW6UwgE^?M6QODb{Kb*5$#kk`haYkvu0NH4pS^ z<5K@bgHH0MiS1&r`nT3XtgsbDQ2 zEacrFrZ*sJzDU>A)_x);R8<)Dgf#xE!>Dl;;Cz1m)>wHyblB4C*Y>3D`b?d@F+~^h=8b>Gn6Jz*gW;M*#W&j^h{-6 z5@esH6DnH9s0~ng8g>Lr{`?uG)^Xb4B3;zpPG!>jFr@LhXT=wfRB|U^ojJTef~(5l zH6G@F37`939fU=e<6JAct&Rr?#=B4#Tx%f~&GIcWygnAB3K+h|*$PTH4Wh!wT$8c_ z+QtaM24qezbrRNkMq!aFNm(eIHDb}{6OZh_vBQ@A+zACFc#I86v46rkZnGZcovODY zOY*uFcg96gaT1MbUtFLCdaSUzr#}CzG&f?x7FNahK)@G=dP4y5nHeIFLd>+u;`}0Oo|gdp6%-u4-5!abxpSmAE)eJ=@wN9w()&xJ-EgZ;pJ0(P|wq_vV1Gxr=ba<36sT-{AUa=2pf~vFtz_MM#|V-8eU^+ z>MRQo-y>ERnmv1YdqS;+Z}KY3T=oVYUra}cGv$z@E?<1+6EqN0wA}%xR0>7yRjt}! zR~NTam|gzaA1X~MoNnY*l(C_SlletK8t{2I=kwkNb!TI;(hCk*7$KULl?D)MVk5vg zhW&K^l72EghO(VY)8?vMFeBVJc?Te6LraWj z1bl~-_>HYnkfucKqDYOchG5)mQ`z(6S?AN-?zf->q%%~OlhfP{FN1I72s$TcWZ2cP z&hUc{!~651vqM+`_5>kb>ual4|kQp)4|tGQiBL@+|3jo z&`~5D$XFzCkf}MDUGzB*MMsPrcp>>!gO+8#TXYbvf%RE%F558nm62&)&Rp~ynoj0ys<5E@8i~_r2Yv=L1D`L*>Z-Jg z{n`0r%{fo19iVX(3s=H*o>rP4MqvdtKo%~Ret%ma0cPNz{KP_>q8zq2wgvG!V~_ou zg9aNYyP%5bbqqQ86)G%stTZAoK5HLa?953?FE zADDSQm0(js+~c0GF!BUmyMa+ro0rYJPDxLX7JFg1IHM(awW3VPIXSV4al~tb86WWn zzI@TnlL|unXz)o%MI~ktQEF2~9deh_KrNPeJ;d!$>oj4XC*t1qF4%tbffJduCnD2O zLxoX=5jl7jc;6ajgpBm68`2~W5@HV>8^b+VY$f^Bb}1aA7Z@m^lt30Kyc|fNDS1Iy zV?M=#ZW4Nad8y>$LP-^LuJxTwLV|)`IT67>DiMxMkQ=btOhuAOn=wRxDZ<#bg*t&2%Z6IDWNEav<2@*$E*CXKu|p(yBU z2fx0~wg-vF#>HLyB5mVhXYa<5eidF=C>{JecfL-QhKUJHcu@d&db;R-V3_&d>D4QN zfqp_4QiJM3g|U%=g)0G|A(jheb?`Y@$pZrJkFEBiXY=6w24DgYUOP?SXOn zoeHPzM#3da31P(>`t4hwf|AnU_cS}6kO!TepQTud)T2t4mNdlN5B!0FfhU_;7OIWo zsf=;;=hHNqSy|;SGe|7qZda3g{q9C0@M7xaFY4wG71Z~(v6(yDBl+y<&xP8r*RZ_y zCNVyJJ9}invaqnYyFZ4lOjhb#pLFA-y!8iTU|@V1A=JEoxXHn@L>_Si8N^X0K%I?& z0gQyqn85e=hZHJ~!6%*3XRim-Sw#Y`dD?Hb$o+#J?)*;|!{%WflVp;N7SdE!vE+gSDPEV5#kW6nVRY_w~S$%Hm zDEy)@mw{b6&1lD8+|c^$GlAysQ+vzb7V5 zh8O2g@t4kU^zc7Fe*EZ}t~U8>-HW-gRnR?NVl?~3F3yYS?Rq6;`n=sMk^@(C49z!q zJ2a5lUi`mcO#5SSNgf|+7#0@R{EH6cAu&;E-A1NTfaRd8wuTq^{`=L9lUZ|tW@h;f z*oR$(L6@X>YO|qRTlOknLmq*wd7Ps6HnBp;91aQ8JVRn-iiCuO&zHE{&fob^6b83o ze$)?QT6^kFH^Pe+a=&kJ(l0HArXx|GASq(=8htdjCp-&H^InY3GAmmqIJo`ff;x*@ z9#bYHxYg&dE1s0UXGBWhM9}BJP(eY#@e{UPY@C`5X0#OYm(z^|7VWBJMQ=O&e=|uu zT-!h(kmTX-jnc@}5-<5xz}*<3i=!jUhYug>FyWw10;U(q65U;0$?53~)!}z{SU=ey zI5Y9{gqrfdSNV{an)z;*4ho}v({darlDHJU!Lzy@Ugs5*8GlNQB%{INGZ;U z<$*K&_BWu#=MeMD3zmUuL#{Hvy{plge=hhY5XgM(xs4ih?Bezj{2a>u84v)n#2CE?O%Kzw60m&vgZfpL}+Prv>x3*U;d0+Qm&#Z(ffYjpGGUxn= z`+JN-pGE=LL!bI|`!)SDc$NUD54u!H^XCO2+hd)$NZFmP&v3H-Ir9N@mg6w=@ucFL zo14(!!?d(*8X4)lnXxg;sbe1hr(zO1N(f0@o{!+?z_C$A&oc?|&eBAALqjG}==Nf8 z!RKfiOCM*=j^@$tU-4E1SAJa;Ivg)Svh_d*Adh2I%kKw%*oI;F6FeYF0^nEGA{&i3 z=%F5;;|k=sa;RCQx_4LShJYL(}jhzhwI| z1%nTzoexXr1Kti5?<_}tHTXeFc88jONndE80I!w|$)_*hhy8;VcZK{3_qF5qz@WQG z+-VL$X^ZaYC*Ks?3N_&k3Bi5K&+`jcT(}s$RC;IIJ%6NN3?U4H3FXLiybP(|U*rKp zcwIj*56Rt?mte-+F@2QFXDD?3UFsoS*x;ENSTl~>R?JXML_{qwVA=8akK|g#Z9H}-X>Xn+D(k2beBmw~`tl_Qv_W{McD6h253zsxNU${LBis|B#5Poh z6GUZ_^oTe5<&2jUu)6k?c|IBBaSQ*x12TV0z=4 z)iCRZEyrZfYwtP?ua^0*J0B>ba(q>z>~9t-+28w33>Tz>CLKA7BayT!S!T6ei35c` z#8I?mW%ZHKuv_{iRbG27PdL7GB?R$8e9P`h4cLB1o;AHOlY?YV5f2K5Tf_QRW>w^h zLK4Q{kOheqtw47-+L!z6JsJyGK_$VAyJd{h2?<89!Ao5p|1pB+@nkXlinn%ce>C}X zPQ3d*Hic~PnN|;`QG4GHtKh`>+(v}W(#N6qEks}hQTJS?J@!P=hjb=4eV`Hoq9_Vu-%6qBmgmG^&sK!#w zh2S<2usNX2h{}+bq%ADuDV|JM_#E0(L0&85$(xf)o^JhM52gr%4<8jtrF6&zmeUer zkIaYzmS(`=ir6o3QLiJiD>m62=%Cs`c=_S2^o=3}>yalEY+xH*!?4+3!r!eFqAq1J zXBE>xMY_wn;Wi|V#lADT{)-Dg`5vO$` zx`T*4JUe7 z4u5p2$*M+9Tqq+<4qlt|xQgF;hzU^zpj>p_r_2R?z_rKPSQ+SDUoUm``txR3CJi@! zRd$g_@p9HUA%oPl`m-*VT%wp;y|(P$08Z;fHIj{y;peNJofbA zJfp2Ea-xdBqUh3=b}SDGQ+aEBA3Sb1gUKYrD%=>`=&K?5s_m9wiU_z_2H@?zidnyn z>8IsY1IZ(0FGuOa+UWk_o}wKSH=SeY0nM2e^SPF#eC6*#^y|k;Su0={QPe(dYgqq# zsU)jcUEy+}?^V^p{36i%tgWfBx$hBqnLvlUFq!fq$JMPSNGvu~Vnv~o>iu?AvaBAN z%xAaG_mF+~-D5f^qKKY0C*Y#?B=-up{q(B{qt7)eQ3u?wSdqYQnDe`g_GCgA=cG}? zZ#>LUpSg@K2Mcox1~V=a)ueE#a{`i0L9(n=2BEXQv9=x*JQYo8b9<1$Oqc%2nhZRD}Hu!7sQHVZoKCC zqnw~r(NV_93Qxh{cYpVM-Q%Z~-{Cu%9@L+jcRDN|>gfQ7?1a0pCn@fv^p*x-uSN%< zFGn+WRfgwg$!1M@;L|SNmTi>TtSeG3eOvl+NAa~Tv{lpH;EhbGpHjBAl*wnwE`j1I zcD2GVA}&3O{^6M4P+f1dXs%#RUn5?t`xJxBm~fJg)WNNlNI^%(8X_jaTXmOj-a>-Q z$@MQ9sB!s$lJsecG<8bXee$(e3kJsR(uHQ6K6j&7j9eqw{x>#PyGcDyTL60AjL#SX zPxzzT;^)wYj|!?VRj0f+XS46i`rhHb?o@t-$#>SC<-O0J6)S>}h~Ew9STHk~CSH%u z^R>-ymNxNRQf$R2L8gZ{qE{=%;EF!`^060Jv-wL ztzG=oqN2jNwYydLM!jm}wf-&cOH#K!T8OTm9_gluj!sau#@Fzfrq=>td2B3>YT_qq zcFd8W6Fj<pKRD|A4 zw`=Yudtn{2D@2e4i#=kLod+lxV%xD)h()FuL_F4CratAgXrcmn<^44L$pUYv-;kd% zc=D319t6$O`6jDbSn;uX#JO+0!6<+T;Eq)5!i@wXM5uwSY@zOL4=4s7MrrSVJiaNi z2tS|K#BB|+sWd$}(KK63aB+B;r%`d;m9-M2P^h&4TSu}x89zoE1{|PH3cS3lMM2`#b!oE#BP${1F~mN&#~oI)Z29d0#h5=m2<+1yEzMD`JfgpeWtT39eAU| zHBaetw5SZYM__sJy9KN%>{1b(JNmtx4-wS*>jm$w@ViiK>JCNLTOjGW7Wm9jFLhBS zy-_RKM27x`nM#P7Oho(LsBG|KdbZQq9nzPU>`+v=V~>B+FkfW6yH6^ym~kKA6lDQ@ zb3SQ1xtVZ!hqu^Ep4F8AWltnI8VRy!FIZ;wNPog5{Kj*W;Z76lqpUl+o%s^YI>yr4 zHb(HsBjJsma^4e4-|{#BmXDdlbu8Y_GsrB(Ga&)>*R)l?A}nUz+TMWP&=mfmsPCFL z$>S~mx*C;gWgf-S{DT<$13ijU2b2S^;Wf6|bWyHB0%Fr{e}iPhaJU&Ku+&Be6YltA zCeFf~*F&r)8^klBMvCzl=lBcXWXs9)fH{_f-dgu~7sSKuoCnU27Wt?O;`v7N@!Y^5 zAM7XM*6<$_i@3FBv$^_AM^PlB(Rgkge;Fb@qS5=27K?}5`~`Fj1K-{X zf@dSU)k5*y)WJX4fbz;hW}a*kY|6Bj9fFn|RF+i>TKv}S$Y~VOSn6X42t1Q2{KT^Y zyHbYFz;Bmr3W~SsEH5QPqtJ#&1#WL*9xZcSUMCr|o-d&-hS*`(`JUz2*%U5Had%!W zp}O`%o+%-!@QdtYX)GBnpDFlq3SOQS1Z_K0Z(1(%@(L>Wo zAjExro8lzUeU)VTz=ln&zd3yl7C21A`+RQu2CK<`*E#9nk&rl;(U;jHlY