From deb632a90a24f86d3b543a014d756264939dcd8c Mon Sep 17 00:00:00 2001 From: Kara Date: Tue, 12 Sep 2023 02:13:20 -0500 Subject: [PATCH] add a proper example page, and a guide to editing docs --- src/SUMMARY.md | 17 ++-- src/en/assets/images/meta-create-fork.png | Bin 0 -> 5098 bytes src/en/assets/images/meta-edit-file.png | Bin 0 -> 6012 bytes .../assets/images/meta-edit-page-button.png | Bin 0 -> 3312 bytes src/en/links.md | 3 - src/en/meta/docs-example-page.md | 88 ++++++++++++++++++ src/en/meta/guide-to-editing-docs.md | 27 ++++++ src/en/miscellaneous/test_page.md | 33 ------- src/index.md | 6 +- theme/index.hbs | 2 +- 10 files changed, 129 insertions(+), 47 deletions(-) create mode 100644 src/en/assets/images/meta-create-fork.png create mode 100644 src/en/assets/images/meta-edit-file.png create mode 100644 src/en/assets/images/meta-edit-page-button.png delete mode 100644 src/en/links.md create mode 100644 src/en/meta/docs-example-page.md create mode 100644 src/en/meta/guide-to-editing-docs.md delete mode 100644 src/en/miscellaneous/test_page.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 738eca3b4..2b19bc5f8 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -3,7 +3,13 @@ Space Wizards Development Wiki [The Robust Book](index.md) -- [Links](en/links.md) +Meta +==== + +---------------------- + +- [Guide to Editing Docs](en/meta/guide-to-editing-docs.md) +- [Docs Example Page](en/meta/docs-example-page.md) General Development =================== @@ -132,11 +138,4 @@ Community - [Grafana Dashboards](en/community/infrastructure-reference/grafana-dashboards.md) - [Space Wizards Hub Rules](en/community/space-wizards-hub-rules.md) - [Space Wizards Role Hierarchy](en/community/space-wizards-role-hierarchy.md) -- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md) - -Miscellaneous -============= - ----------------------- - -- [Test Page](en/miscellaneous/test_page.md) \ No newline at end of file +- [Discord Rich Presence Repository](en/community/discord-rich-presence-repository.md) \ No newline at end of file diff --git a/src/en/assets/images/meta-create-fork.png b/src/en/assets/images/meta-create-fork.png new file mode 100644 index 0000000000000000000000000000000000000000..a95bd65b08ef825966c286077155cbf2c275618b GIT binary patch literal 5098 zcmb`LXIN89x5p8XqC%)f4oJ}mC?E&n5a|Y`M2r-r2?UXLIFLZ3gx-sQ5|CmE%_E9R zFNPRG6GD|@=nw)VVCW@CZ#Vir_kEuG{eIYc&&*yk^WV>&S--U=(d@1f->E-Nv9Yo7 zL5*)&u(6#$vdZ2(T&(-I#4EY1#|d8xBYn2g9*KEYh0`4ZgRrqxU``)6on+N{eT;2= z+1U7-e_bcqyg#_Gu?a^&Z$a({!k2Rv%gzr5B^(0On$*+MQ)6Fa>8H0U&Pz>}!y>0r zADa8ja>=1oz=bKiHpr-Gd;6j{Sps|pJ={hjA8jBX74CN!OBa0Nyd*Tkl*xR3y3+`h zAwQpR|D)NJg26*7@qo2nYp`})w1{I<${!oB-7L$T~t7;z4BR{3g7T+Ku6`E%6Je>i+MhFv#yoB!%@ABfX5uNig&+EgFB_T+#j6j}Ae zS^8p|TT5yyJLX}OPd7$PvxC)_8uoogHecz~@ixTxouMpILtm@=_qq>65zOQkw#Js& zMbKZ1C-6$eudrx2A4P!9;|mhOYv$W-auaV#XhSX=L5FVW+}6m-56wljo@SK9m_*Hm z+b0zew?ov8A(V#$yHBrGT|nGGq1g`l%NKINTh$dhw27I5kb(=y$X$EaUhyFF)}o@K zZ`t^=2Y&&rN^=07>Rx<{x}SB57kL%mZi}IeZ%USV*)@g32Q5!ojgRziAs>@F^EA2%AuFNO+eXcd4~jza5ua%v>o z$7i|IBvoZrEEj(y$f88ehKi~XQRfG6EX3o$gwymY{~1T_4}Z)aL>)vsR;>Q2(>*)o;IW5f@3jP81d!t6+B0bG7%z44!Y_v16hwBaZqaPucbu0(by*opR_w;3N^Kp~t|AAwp`|OLB50LVoZPH=&*@uR+zMy zc(8O5kjvv9;ybtGd|2I+DDLR6ExYn3Jy9GHh%il8e=@$}#E7y)e;!mfwxyg((n^9R zixb1$5)`IC9UM?LGp#4udNMV7pNMy%G}b`1+dr{D65n5sUTl}?0k=Md0%@v#I)^EW z1s&ellPEx@_2${A1}z%QzAH-Advn17AN9#AGoP<)*@Mi5at7GpAms@;ZGVT1tI$>$ zwlD8(0oT*kmc+dihI_I*!!KZJPxXW+w)H051}UzHdaB3oO9g@`)?a(DNdGQtr$1<| zH``IOI!V=#9|Y|-S9q4jg!}jMmkA|Tg$!Eb@YC9DJsx5JW}cSH^_A%oJa^@AgVR>7 zt{w}5Wz0^DV%V!4f$t9NIz4z>o9W8?-Gy=4RiL8$O0^oB-)VH^5F^VqF z6kvqwsPCi;xT5)u>0)7qwXV&Z#Yu@2eAVRD2P-$PGgndObs8;*%=XSM>P)v+rbtIE zzef!2iTK0WX9!{GvV-XyL}K$k1^(sH(mw=@vBo|yeIx(z^>AqDO(lQBDxXmOo4{B+aqk9;#qn2K`od!<9a zT0)8_dY~Cf(e62=wfdvxDbt6Xj&>k(A%tpV114*;{}n|$wj;;-J_m$5ndDNHmxr}K z4#T)x_=<^(8R{?J<4?@+iG@7hy6$5X#^7)Hcsf^65FKGKG3jkM9j?uk?lHFBs>y8c zvZiz=Y5nkT^h$O)gTm}-=4YXE$Xp_57_GG2RbA-3AXp%1SPAhb0>xq47o@iCn(f5M zOx%yQ5p0mA)VCziwO?f=hpdekxD>hEN415WXd7+&hWwzdaz?cW=p(&Ec*i#;kMv5M zasnZd+Nmv`k?{KKNi7bDq81?7Wz5w3KJ~m1xG|=kW%yocMGHAPbxISH4p3X0NRdHj zC51?Lz$pd_9xb9!TdOHe%!4Kqhv%kUqq^A=mX!R?TFR&f-;=Ze@yTf}ghs{EN3H%yor*IJGbi>W?S0nDfexr- zo4V@?18)wOb8Rph(GKl&V|eEB3o%E^!Nq&CYD&n_3mRKH!&M2HjzorWfcDq2#rZmryUgd_8C~EkV`kCXKF>4Wi#b zS#t>W2;<(}rV{3=@o^{|Y>cS$ug61Q)%3c84f`K~daQ|AGRv&!V0(9xiCS${Y zg}8YGp0U2La79&a5Ed1!dGh##>#19-N;;97CfDGBk*5C4gWKX z2%5$UA4-`2*foCI?~B0@z`>txun4g37C4(3(L1v|`^vyVaQnlCnCmYRC!0}tV-g8& zNNP@dh4#<(#Je3K^9fe5+mjJ`2h)IKU{;u)|GS1>s;h+nT0L*rJAmPFMqW#S`5rIK zVt#pELc|{_1TyaTzF!I|JZgO0@ot!tcV~$;&)Ag}0z;LB@efs907c+*^mDaFg^0iq z&h)B<+yJqWjrhiO94}n-j;I1sxmS_aU8o)j*8elFXvyQnf8(KKqOcsuvKS9kc96Vk zTd5uTaNVexJL~6qr{HrT5%9c-6@_uM8M?ETtnA9HKWZIs?pgFcEoIN-y`2r>Bf&J| zL~A%h!&mFJziO=#$M-}1Wqo`)$fo#B0kWGsl6;xj61FQU&Yicn-f(<)9FLwnw6qDG zw?yj1R*NNJ{gTe1>=Hx%*SNZPU9u(?W)}d^HK%~We)X@$SBPGiMmOx|H5CdR(KlCr zzk?D{)EKRn9-NSkF>EO?|m_rA=-{|cm>^Dvk zFf@x~Qg&u?{|LZ+ihoq<#aQ|L`zCYyd^|MCi~_PPx2#+kJ3l?#aMXRH*=f%AP9z>p z^((T|lR?DMWT7#2%XYdE?pwobMO+!XeU+y1WjY5n8DQwCBrK@+lF3y-+YvJ{DuvEb zZ?Lo{)|_-PMs2bv`d}<#A8Ce5IZF0aE-plLHOOO{jb2IgC}-U zGAfPcxwWs~f2L7uk0sIhJRQ#4CHqx+67L$k(t)`lN8?UiDZRCu0v0FnoxV2d)fNfZ#8BfBa&(?jR2p6#gp6oS8iMJBY2XeWnU5)b0IX{?yH zpUyFgZgfYG{jVbxSc%I=UY2nx5g)N|fJj;;{;b4;vnCI=8rn)@s`FOES4*0n@*;y@r0utw zc%FI+9@``{8^fOLe>dTHJ1`1jjgl`+Yb9-v4dZAlx|2IUHeTV^`c33ERg+x0Rt%DA zF9pV!bCO_&ke20lX>K2`jK1`|g{tB7{xeBl7)aVfW!RK6EJa>9r~szn9b1|C5ivPb60>|dCC!M@?>x6D7342zVvcn^ z6#R+5*nTc!6WH#bF||3k_4e;?ovoAN7h{Q@ij2tKE$vIj)Jor`iqe}jb2vM5ZVN)) zIi;>AUnDGjmm9k>n})iwcu(xt2ldmklHbyODmLROIuu;Icoimq|(JdGs6CC4M6FVq!P5MwBu zG2!WnF)}?Wb=Wadtt0P6iga6hQQMt7Wtu-6pk-)bSd-XG=F(j}^7PtwWkfsYZ%EgD z&}&bYc1h9eT;L3_k6JG4j!`cNi~UzOb6TT>S990Lf-JDq*hNZnw!g0xC76)x zCYQt=UG21JDDNo+VN}e+j}>_gmfPJsVm9=1_9%V?#J%C!sL1tBll0(|c2aw9y%lqe zIv09z#FG%_Dcl{~^9J)Oho2vYE(KbPsb+L{0a$v5ZOE5k<(q*cz7-oM1O4Yv=>dL( zR@@1Jq=j!?&g1%Pt(C>5Dy+2@-BXH3IWe!Yv$F2h_!|;8`qm{0VFwvdk@5PYGfOk; zdxc`N+Jb(Xw6v?UURbi+gz1|Pha>f~4$VaE;B2J|M5o56_8+e}f)#Jvi8#TWlXjL+ zb%Updk4U=~+0%)>HzbvHSM4K_z?o-C3w^_UvjTp$OBt2SN}u)u5`6&in^o!;%77Rn<8?04jxSMEDhUT`*lAZA%wf#$zH6n0jC*>iGA zmFA}zEpeKxcb@S~xx7uq{|8IP-$nA6)ZyPMAnqik7)&0VC@~H#q?;*6mo!H|l)L4% z&!dScX4<$;x1#HFR=xhSSK$sVH3x7sTEA;AO znKiicU;Z5AzD<@DS7!^{xdkfO!T79j_#L%pA6cTcDnUdE7fkLv%~N;0lM@sKs+Y$k ztlU%ly`}+jY4Q2=B~p2MPpeEBOGbd1p=@eOjceVOzXq@7#8$6RKYyxp`dPg+0EAJ6 z$btoo>oTFcFYBR_6SC3EddxS9;R}H#cd(D|YGSy;z8`*fwit5Mf)&eG`JD*pEjHPRCv;x-&NE7p%=oRJYff9(=`99?Lzc3`0 z(*!B6s83B~fF!@1s8fU4wQArR3N$}rN*L9$`FKyZYtzrPH7mfLcCD{yNPf;kWz4`@ z_7JDY_PHr8!$wo(oECH0uefKvwhb(Q6+`!s*iG3WobaFh~wWiG39466VA4&OvQ z+{Sa<;*mkHmog=WKqaE!sZK1bzib`(>;olaWZ1@>p2VlAg|lUXu#`3^jRLKo|fEW>*D(p2ApQ*na~g zW{os_1^_bs+k5y`YTO&)0bi8Wm>?2>9Ddkl{`t$>Z!YBaQp@6+KoExYSN^M|x$5r+ zKfj~$FflTWY_l%$Apz{a+Apn?{{^LNx%Pv=0HB!CnQpw!7~%jH_xb3rFHHn+vjaH* z7zrjI^X~yzOira|(Fm#^@qIUI`8=K~dY;x4E+diWh+99$)Y+EI`B{tzV^gsAvpscJ zct&1hxoM~*W4v&QZBv5zJe!myMM^^4Y6zNWX#toQOM#TLQfX4-yfXx7$W_l<5vxUc z;3bwr9>d&t-=@j+ppymJCifIx)h4G#Am?9+g1~bC;bF^*cm&C~#fy%_LP4QGPx{y& zv4PYY7o1=7&pi^WMKOy@hwUumx^WUsy~-NTC0XTr+Hb_r&eUay*E>VagGxZ~jySmd z;Wi&X_0b0HH6B4L#@)h|&$9;r9v?|;jjG>!$1?j#e$c@Kv z^GEjuQt;Fy+0ZLTKbd1aCKKNiU5I{N7nca31}p3M<%B`sayMzcdk*3IL*Lt?MkDId zr6&?6OtD{i=5BH1r$3p^mKhhKzJJl_)!3b|hw{(SwREPDy;1gRI@F!JtWZ>8j7o?B zmZYq~>c7{?f2_K3AX)vyvYf!&)Gn!MHOKA+?YlIPoR7Sf#W(Q|xJby$prV5pPz85v z_t^|i?c`5N5ldxxkxndmkr`1in`qcjXLAX6QVySztMGngMA$M^x_Xr$wMw)93>vjm zC-zGv?HF5R&BMzr2Z#pS{T)2-WEZG92Tf&Y(X^vy9Cb-K7$6G581aGEP% z@Ir5wkols0dt%YtbeSmw5ev;g5R_goG&b)Oi6X}beHsD)=Dsvy{ysI+^Rw<%o z@FtcJ88iR7Cw|)C8nm{SXD)MNdKN0)C|KB2pTFn_%n?4N=9gOy&uc-;JIk)6KdN`Y zV|qmh)xZBKC#IqFTH<8BdHK!dA+sL308pyC5_0SVUe`MtX6IkEf)lfW%nfg?`QG)R zN)l^`x!Vk74Q>BwF?^oD)7N0FzE)Q4kZUE|ev5ls9awwpiFm|Dx>e+`cE^nc-=T~5 z#=VmSL+Oc@yiCG&mKUe&2VEc6^?6;0o)Y83!@8FUscEod~G>wT;O6uCo<+(a(> z7L83v0Pkc)-dxbAj*v@(L^-KSbVNYkmVOH!5N-wqsB_Aysq_-e%yKS+j>-VW@JLGGQ9pF@MIT|Fc1aF@wZ?G%N1 zw##^S)$4qlj`~L)?1vZc+7`=IwkMXF)#8_Sd2+ zvyKjnodkhPpPlFazSSkj{o?@-vf9wa$M!r?SLlRSJP`^^xOF~^GbTP--2@52n8;OM z$Lfs=zKUQH5hXBNNasf=h1(4S*%zv$YU5!AJho?vqD;E7BCGeG2i|Q~Fy~yt--xB8 z58vdq-Qb==7!%2AvqMIDR`1{NRk<2q``HzEkx5J`F|8rrwCVe*7XNva*dQh|ls#Md zSlz!iF{LgL5cu^^+21?yYG->GYOW9!q^e;YXtW@K=hMYQLbzzeVnj+qqfg}aho+_{ zwITDkNlIUX6sf^E*LP5M`L~@(rG$|6VwB^ArlaeUCXGa+J@1T>Bc11=R5z zlBG&umK-?+$3iV5+DYvRcAj@|vb4dW3e3`e9XhTrl#l0SCzsFeNiA(CRXtdj(Zowz ziuK9TW3l)z3)X-lZ38(!MrB@uLO=9AQ9)`vVhklli0oIk^$&ezdDnxbcPyYqbJALU z)0!Ej|1q6cWh z6r#x)2unVSIShN{OdmF@vDH$Wn9Qi%jnG4|Wsa)AvDn7bzt-Quty>J-#)c^KGiyal zTFDOa`j$o3X4G{LUw&pm+}3OC8mo8B1D{kiZHKiR3QJZy&(@D1udu7yN=-ac4wD@C zoZ_!Y$<>UxBvJag@R%z1lM}U$uiC98=iO<)&paoHFx1?D9H2t8!r1k_vqOb+xGIJf zm~z@}N*CRAB4%xg*+xLu;#7Te_h%G>LEvBVL$mZ){~&JWc6y4rxWbrY zD5pL=0giX78u_qkU$v8c;{2=od-u;EbZdMSJ=V1ZGKGC`Eem0D&vv?pT#m&KmcIePq?a(jK>nPWu?KIV2wrtKE(7r=evAKa(!ym%C{-{Po| zhx1L-TAmW=Px(z@v|_Nd+h1#vf;59i27jEJ*uOyLG#bFjcpX?Em{% z11;A`hLkVjn9{D5c1O(F2rGB4>fsJIvt0x#Hz8cn%Kn_Py@ooquM_+f@rLbBU^ZrD z@4NKL)jqA4jIdw3GzA(He>v$W2PND1<&ra#1*=#;6yVCp1spwlT^ zV!JW6s%yHxi7R|9Rb4+(oS67l!MG2R*2%Q+IM1Ax#@OD`^|83}jJ$?blz3&CXTc&t zg81zV6Yaoers7Xv)Gn0mqqxr9OzWHpLfNp}px4;Dahu1wqKmZOZCtT^(0$(ZIY)^4 zg!Y=Ae@7!%@qA(be~Ym`{p@;ts4g!oc2OgbVY(TaP$Ea_tR1E2KVA2LkQ^fxg@4i! z)gs8)b$wmx)Jja&v)dl??$yrj=HD>mzqw_>LwD~ts~j56)aI%omY`d!>cu*mu-?Di zd>=)QwAiQ^rWTbKleQ0tUSh^0cdk_}6JmP2g7(`UWVG)7>>Ky=9u2f{67b%?@7a7c z<$?t9G;@~#X_x(k(R@?;5IA8sv~U9Iiq~5mqH;kh0MM z(u?TztASw$mWUHCDVu=m4XuyvZoK45e>1M>(p3NT&R|2s^bW(EPSrABc+{X`Xef9C zOWmK9?2l}wS?rfU)kAvLa6M4E*ShLyq(bi&G((HvXL*j9&aZ2^=gtaA0`I))1~#rA zTYm_dLynAHar4d+?y+$UAvLTFbNJ7jV5q6aq_nJ;6p^F|dB)l^pn@fItr22GOEq(( zcW7`xvV>hT+&oCGZW2VeZ>mS{R;9^^=847hFP$MT{88IK3NmK)+)0$T%0v%!&)D&b ziV%|VPkPE>9TjK7s8O^ONv_sGl7DN0M|e&vbSX?d^h-TqBO|nShZ{L*vO5der>*$L zSx(FUZ&72|N25UcCA+S=tTRDQLjD|nzsEnwJAh#LZ?3Pmd7D@Hc zx?~m+nu!w1O_JZ<2PHrBo8#P3y$X4CLa&A+P+`o>Zn_mdAT(D$Enn^2ox=aacS`=< z$?BeLso!|r@$$zv7=D;>V=N^tnME&qgwv&6R)x%ni%FaerJI8-$kGr3^z0fvVlyoP zbv0}ZMwl3SFfp0j#vmv9vM4BRcge%;h7tm9Wg|pzXY$FEU%)RbG2Rjf?w8mzOA>aq z+^|Q*9;DgzzfsA$Yh;nC)_x zyz$sGWz$H>FLK>wsuGRc%2xBQO)|yzS({?Bo>npYf{gHwU#8^Q1D+r9R>O$O`zu-$ zmQ5=P8wFeV?5x~q7aOcVNX3JZ;-qdJnX~D}o%JD(<()e(Bf6ZsGh-=T+KOp^HidJ< zuq7Sth{Zz}{c_QPyF{Wle-5|6d+1(?Bdcz!R~xPiHqKER%#f}F6^pwn%iC(6_@1m} zffqr##usnBR0Qn`TSRK?j;?u-P;ilh7}i9?qz}u{T3{~sqs|4-+s;FIY*qKrc%+CI zysK^qZp~)9B|Q{lx>Lk$IkPuf*Gt}PWBcYo4k@eu-u|h>TJ;wM(5tyNM-SgDejAY; z%`6hxP{lZ+!`V}7^CXq5UWIta&0N=~p!?5fL@fHB!MEBjX3V-%DYAZ%i?r+xsaHc= z%kQ*_LtJI^m!Hk{Jsv$D_wFDK4w}y3xQn!JE#c|&x>+2}>#z}UV|oXTu+c`gKsiU( zQ^u~_)@-}4OhqBNR`WY)X!~s+j~7KER(8zn*^2w6MPDOyJ|}vWVnWF%J389C!YS8m z`MScVC`ABNL!UjixR=VY(XFDMm6BSf@+P}>yu`Lyir?JHQS8M$acwo4q-0TICAFA7 zdIN!_oH+D!*-`Cf4T37~re&WMl2V7f>B-Fe@}|%p-Tggt%R=()S_5WLpVIqhUclO| zXM*pG-~ucMG<^ui7x(xRo^otFG=AR`1BpaN(n$L%aTd^m{rs1FJ+Iw522%6?o?GhP zdP60*RSF_muH|z_6)X5e{WX|KRHC^5c$-eou@g4nu#_bFUG=N~J*28pEiP3km$==l znz8Hw+Cr{EKFqliG_4Sn-Z%Ck4)*4sp*J@$>(P_pn)4=-@0tWK=UO|w-Hrxb@q$te ztM(_$rGbqBBab^rIqbrEe@6c-F*2Gj6tNNR&L$`(AGG_FjNdmhT;ESTNqG#LzaLKM z-M-Ji$hO-#q3_W|-{_b5LU9a^)}rp|FD#uV z8Tg@l+kHB>gR8o+s{<0gg4x;Wn^2Qhg!4t)UfI02Xj*f5bXCnQ+kfQfLH9kUEcXmu z-?dqDDPr;&bChm(X_`!HwR=*?|bnpz;m9szpQpHwX>#F zo;cVC5@zZ%!}+@926zRooDhLX3VV?CsJVN3e?);6&u1XZs=w5>&!${Se&p(=W z!8~XN%$*AB5_c_^Hq23N|LM0nNBU1RD@160O->&iZiK}r!dTSc)%S7m2UF7d8Ec=U zz?jH_z{Rnk-5LmeUaaQauH>bvEJbkm ztpyV-KH-2>@E5--6kUBi&apwGvotose&(+?&prA`N@OAWW__i`h|5O_Aes5?RXp;k zO|BI}yTR4Y)<2*TKQB1pdV9GIRB@O9_@X?0N zL7k|*?-P;B)N=K>P|{o4MQP@1@wn8ICk()Inz^i7oiry}r(QLGk&T?pUM&x}p7hnm zQ&pu(AU%(n6Q=-w*GH|EK?lnR(`T=9&3D&&)IP(#%AknURkX001x};JU~&*>y%J`txTz zA$z{}Owjlu^|b*N-voZ1DL^+ZV=VxnDiL(zNOz_)c)?M=002wJKceZulsE$bOc4lO ztvdmB>)GoVaL=WlV9OOIE3}*%X&@? zUMw_0mS`iQWv}}Q51O4bd0tc~#$3IPHSm00ib-)W6B*_HfP`2TV4f`dZ@8|wCO);C zTVI%i3k71H2>QD{%bm`cwta^A^3j70$R1fBOwW*l6^6nYu}Q)b^xD`0FJ?ibFEW~G z#ei30rS-*czGVA=zm&qWi$Sks;2KW%^E3i(5NT0*5kn~V~fi^ z;!nX#x3y>tvVy!Q3&KYlCkppvY)@!Io3Fxb{uThN6772mSuuJ0W}xPx`Y6^EqPLO0 z2})Gab0Y@aoXNS(S6V* zEFqvBS;@s*9;2C&V5TB z;RRj*Uc#9Bni*X{o;&(ZD$^ooKF9Zw2WU%tKMA zUejkOtuZdhJ5_%Nzuoh=>1LtzBF%=PkYf{^H7be{`GeHxFNg%$IkjG$lS z_&gg!oy4uIo}evIa$>HO-LI3;id7Zk##eGYYF)$?4I%VHHL&Ly{KrHp=PRD}^$z97 z=p^t@XDew%ct=s%l)T@pWp7yr*L#_6&{!d*8R3`@u4bD8o;KSxv>#49ma7Iu+R~p# zB;N`i8@9l1%?x+0oTK|SBsI~{!d??E`O=dF)nn2I@^)5vg2w!qXrX#joB2(8j1KW> zntJXBU>Gk!MM2Mq^r^Nn;`=_#BT0k>f|PT<2$2|$K$pBaX=p+x6h8Y2>OOs^ zovg&W@QT>F5tFvhxF;oBxnJ?COF4pV_PY4s#9ZPxr0?k+Eo4Ew&*-Cjz|Ccq0FEQn zIPE~5E7eIbTLvdhy}B)~BZ6GL2V8Viw+FGjb%co{bc*u0y|eALL@pa}{=?m2k8g{H zAiF-T*uFvS4t0CFAaF48xKv1ZjdZ?seL&+fL~oA2B&XrFG|)*)DJak`1?_w>6TH#W zq*pWl**;-PnymDDDr?%TwVH)WrHb~ursfs+NK=$f**wh!RWUsRz9e#%_V*mk`2l)Vz?uaGZgXrYKw*^E&~BrJt6njZRl zxX(N+azz!e#g!^~r5Sp&m+Qr>OFS=tE1?Y8WTEpqZ_%&sjEds@STnO!w}Oo$mcF|$ z!HgkI_(x=~7E|-MuRU0#&5^MZmr-B$YTSnapV|wi30s>kevSHaLIXmFpvs27YvxjS zmw7|sj2DE}dnb^sz*jwovM!~pc5^lXK6$|U1#|W=2elY^#pFhc?&_nR;}Eq?liaXh z6B_MH{S!&b6848I{t8^>C+sYne`ne$0-e_D7JdG=X%J*KF>XxfU0WvgH}oED!+k2F zQVj&8C1MEK3cl^}%*IBH736Q+;#R>JmO;DgHe- zS#q|9Iu9}=hXzHya^!sxi2>D)N_ zM%HZUvJs6)0-J>WX||e9a9!jsOfOi~o?gCn&@wW1hN{8wS|n^L_*G5JPT~B~2H}|X z_v{}&Q+I3$#rqtT&Jk1vhk)`*dl-_y;nL9}_+#*`Ok11xuw-y2y=Jy-ED}#nPA2@> zn>)I=IV6NxHH6Y_rOR1mL2KNyNt`c?(=!C}z*W!`Yyi$d8;=R`=Onf4i)ZpQLh0nH z9W}~XW_U(B_)oOjh?B89rd5~!H&92c5+g`BT+R_(kd^L9fio^tIgMJfrb#hx7NZx9 zaZI14N+^D3jLFu06d{`OfRhw}#Tx+~?*Tf>1Ls%mE zM{jzJH;3yyb>Q!ZsFVDWg+2@TN$MCmsz5l!wN^0>&3gD!iGmx>5)V4W8(JjZ_KF8z z+g@3qq$VCz3a|>EBzp1KUSJh%^@2S5ev~D6y4-1J5%SZma_cEy!|72*b;9FzG$o9+ z0)n}g5C~tp?_NRYiFMT8r|Ua0S>Ucbxu~WV@;eFpCw$)s(YUQiPn20cmOL0Eaw75GxfEe~ z;v-93G8hQaM6!j4KP)7v0+`;~V65IWtT;Km0|h<|k_%T|MTvUUylnfddc+!Mh4z%# z?lk2-ANS`{cgPd)$&Cnw(O6CQma#3+AMi*}25Gx--@uVx80VD7w8p+oV%BgJa)SL8 z`1LY6!r8RG-wb#3-cchJbYC??a-x$6z!q<=FnB= z%0WUEY^^d$WKVyfK_4f6Gn;9nIIXifZ9TIgW6z@Vwf<0)cpdd!aWvVpB)Aq<>E46! zsJSW%v-YT2y++Gz$SyF)f5GL_52X10?M?YSU5~eW<(SdS;}5Z^WWOqvI_T>}CaXxj z>EMunXJJ(E*r~yi@#^trZ`DT|d#UvY;d>T;1xh7tW@m~B8tB{-Y;Gz$L6hjKFcu0w zcCLMIG}IS8UAq&l?pp^Yvv5Vq2WJhkpR^Trnq+(V?6J59PBuhU%UrTcJcM3jN6n{4 zfTQ29JJ=m|en@i>IqM+oLSgbw@X%D<)P$LxsHw9MaQgLr4|gSuu2Z*4I9i~J6(6k1I(pI(r*tX^~qui~97E*IA< z{SkHo%$mBMaNAz!i3Y=!?M~?kpO%l`9-wwnb?R2UfmwrY+95J;M1l{m+f$Yjk{T|M zJD}1Iah_|`w&xE>ZS><#l(xZ!DhpXuoo7XV5Ra%#Kin^tMw0Q%MAk8}$<|LJLhg-{ zp~yzriLw#iwrZfW`EGydK9n}{)?l$ChuHp?bc$m51+hSn2b8t<+OR673@9ydg z?wg;<1Lplao}do?U0qenoDdEw*!w!;GXG#?=q*N2nSHzEa78HXg4bZREpu52r`!_z zu>pk|J#dj2iU+63O>J3^NtAQ{8Ylc9PGb*8L%6#CAmc0r*&kQ6(aun=D)~SpYz()N zn;6HjG0*TtK8drfNUPCe15Jts6Y(+PO$NPq{hrn%N`h)Zz{*?djo^>gfxtq76*bj?J%2MjTgp}O|8G5Z#a=kWY zTMs@a3a?@REMiYj%Qly|sg}O+U|{mq|G(4!<8c3P4MbhVQ&#Z#0CR+=e$3gI0zl}Q K=vHVuVE+fSnner% literal 0 HcmV?d00001 diff --git a/src/en/links.md b/src/en/links.md deleted file mode 100644 index 817dfd456..000000000 --- a/src/en/links.md +++ /dev/null @@ -1,3 +0,0 @@ -# Links - -{{#template templates/porting.md}} \ No newline at end of file diff --git a/src/en/meta/docs-example-page.md b/src/en/meta/docs-example-page.md new file mode 100644 index 000000000..2645b07eb --- /dev/null +++ b/src/en/meta/docs-example-page.md @@ -0,0 +1,88 @@ +# Docs Example Page + +This page is used for showing off plugins and styling available in this `mdbook` instance. + +Its best to view the raw markdown source of this page, which you can do using the button in the top right and clicking 'Code' instead of 'Preview' on GitHub. + +## markdown + +Best to look at [a general markdown guide](https://www.markdownguide.org/getting-started/) for this! There's a lot. + +**bold** + +*italic* + +~~strikethrough~~ + +## templates + +You can also pass args into a template invocation which are interpolated into the page by `mdbook-template`. See [their docs](https://github.com/sgoudham/mdbook-template#format) for more info + +`\{\}#template {link to template file})\}\}` + +{{#template ../templates/outdated.md}} + +{{#template ../templates/wip.md}} + +{{#template ../templates/stub.md}} + +## admonishments + +All available admonishment types. + +To use an admonishment: +`````` +```admonishment {type} "{text you want as title, or leave blank}" +description +``` +`````` + +```admonish note +``` + +```admonish abstract +``` + +```admonish info +``` + +```admonish tip +``` + +```admonish success +``` + +```admonish question +``` + +```admonish warning +``` + +```admonish failure +``` + +```admonish danger +``` + +```admonish bug +``` + +```admonish example +``` + +```admonish quote +``` + +## latex + +\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\] + +## mermaid + +```mermaid +graph TD; + A-->B; + A-->C; + B-->D; + C-->D; +``` \ No newline at end of file diff --git a/src/en/meta/guide-to-editing-docs.md b/src/en/meta/guide-to-editing-docs.md new file mode 100644 index 000000000..d6fec4cc3 --- /dev/null +++ b/src/en/meta/guide-to-editing-docs.md @@ -0,0 +1,27 @@ +# Guide to Editing Docs + +Hello! As you may be able to notice, this docs site is completely open source and free to edit on GitHub. You can see the GitHub page for this site at [https://github.com/space-wizards/docs](https://github.com/space-wizards/docs). + +There are a couple things to keep in mind when contributing. While we disallow web-edit PRs (those made exclusively on GitHub) on the main Space Station 14 & Robust Toolbox repos, that is not the case here. **Web-editing is encouraged** to make editing documentation as painless as possible. + +If you want to get an idea of what features are at your disposal when writing documentation, go to our [Docs Example Page](./docs-example-page.md). + +To start a basic edit of a page, simply follow these steps: + +1. Create an accout on GitHub, or log in if you already have one. + +2. Fork the [space-wizards/docs](https://github.com/space-wizards/docs) repo on GitHub. + +![](../assets/images/meta-create-fork.png) + +3. Click the 'View & Edit Page on GitHub` icon in the very top right of any page on this site. + +![](../assets/images/meta-edit-page-button.png) + +4. Click the 'Edit this file' button at the top right of the file view. + +![](../assets/images/meta-edit-file.png) + +5. Make your changes, then commit & create a pull request! We'll handle the rest. + +More in-depth information for contributors, like how to test locally & port pages from our old docs site, is available on our [README](https://github.com/space-wizards/docs/blob/master/README.md) for the GitHub docs site. \ No newline at end of file diff --git a/src/en/miscellaneous/test_page.md b/src/en/miscellaneous/test_page.md deleted file mode 100644 index be86fcc41..000000000 --- a/src/en/miscellaneous/test_page.md +++ /dev/null @@ -1,33 +0,0 @@ -# Example Page - -This page is used for showing off plugins available in this `mdbook` instance. - -## admonishes & templates - -`\{\}#template ../templates/(file)\}\}` - -{{#template ../templates/outdated.md}} - -{{#template ../templates/wip.md}} - -{{#template ../templates/stub.md}} - -### hi2 subheading - -## latex - -\\[ \mu = \frac{1}{N} \sum_{i=0} x_i \\] - -## mermaid - -```mermaid -graph TD; - A-->B; - A-->C; - B-->D; - C-->D; -``` - -### hi4 subheading - -#### hi5 subsubheading \ No newline at end of file diff --git a/src/index.md b/src/index.md index 2ace020c2..2cbc3c4cd 100644 --- a/src/index.md +++ b/src/index.md @@ -9,7 +9,11 @@ Do not rely on any links to this site (spacestation14.io/docs) to remain alive This is the developer's wiki. If you are a player, you are looking for [the player wiki](https://wiki.spacestation14.io/wiki/Main_Page). ``` -This wiki is written in [Markdown](https://docs.requarks.io/en/editors/markdown). If you would like to make contributions to this wiki, it's hosted fully open source on GitHub and you can make a webedit PR to any page using the button in the top right. +This wiki is written in [Markdown](https://docs.requarks.io/en/editors/markdown) using `mdbook`. You can view our README.md for the docs site [here](https://github.com/space-wizards/docs/blob/master/README.md), which has useful information. + +```admonish info "Making contributions" +If you would like to make contributions to this documentation site, it's hosted fully open source on GitHub and you can make a webedit PR to any page using the button in the top right. Check out our [Guide to Editing Docs](en/meta/guide-to-editing-docs.md) page for more information. +``` ## Getting Started diff --git a/theme/index.hbs b/theme/index.hbs index d289ebe8f..e4de8f93f 100644 --- a/theme/index.hbs +++ b/theme/index.hbs @@ -149,7 +149,7 @@ {{/if}} {{#if git_repository_edit_url}} - + {{/if}}