From b673a42f17fd5b7cd0e62cfeab27e17ec642c474 Mon Sep 17 00:00:00 2001 From: Robert Eggl Date: Thu, 7 Nov 2024 10:42:56 +0100 Subject: [PATCH] docs: update setup and features documentation, add changelog section --- docs/bun.lockb | Bin 94967 -> 95729 bytes docs/de/app/features.md | 4 ++++ docs/de/app/setup.md | 21 +++++++++++++++------ docs/de/index.md | 6 ++++++ docs/en/app/features.md | 4 ++++ docs/en/app/setup.md | 21 +++++++++++++++------ docs/en/index.md | 6 ++++++ docs/package.json | 2 +- 8 files changed, 51 insertions(+), 13 deletions(-) diff --git a/docs/bun.lockb b/docs/bun.lockb index 21e7b0570c0c011ab7a3908d0949c3fd221440ba..10807463922fbbfd713690c9c9b2c4a6ac5d900b 100755 GIT binary patch delta 12101 zcmeHNd016d*FXEh1un=8GS7kof^bz(87?Ry0tt>dD>5jcsDNWC*DN({P*1wkv`jIl z9MLc}lSEOaIv!YectDLzUTX+^W1fQYpuQZ+G~$zpL_PN zSG0F-XcvUHtp6r+-d<;+lJ(e>Te8@G%itB}=gJq3|EcI^`S9DCnl;%Im_XOS`%%H;3hn`-C5-E2EH^Gz6fY<^4oK}ZRKauwJ1N*g!IH6~M^6|B!(c)10ptQv zwy~QchXXwzI{AvIsq6XxsmVJlb`$dpM(4rr zOug*y1dv+F0HhIA(N+-R$N>jK1-3>4^-Um?)!cU#seweG;y2Ot^9VR zJc2F*Xo&8BSvJ87@g+^nW`~y zLS9&I-k1U)Dj^8Zm|*39nqle$P-luVLmFmGvrcjc*`Oc_xL>^79-Vmr9$2AO(eTuEMb4%%x-k{q6IS6N?|EDz)_AXENtAo~H0KpH+5 zphtU`8$SR;aoZq)I$$S|2J%uM4d9VVhI?`bV+LgE)(${g5&{&gKsr?stwqc3{NQ3Xb8>^;R+A@RCNXr~TPBDki}Y>T))#K7)|*Fp^1I`l{nu_h!& zn}9i*E^)6YT&#J6su?;^P86thvNc=*t?o^9@`emd7M=$0mr^S{t-0f(2oaSkpR2 z`vBYkiR&4n>fQ&}Thi5o8zOOon+rmL#2o;aEpZ_&aGx+oO&3X96%t}<}4}46mT)(7`GVP9pKth2MU-z;vI)j(ce|qq_rT#KBXM) zV5OS^Z8WrI;x^}K-Cjr?C22gy<2^_jkaXgBk7(N@Oprc*%+J<}E!!G2HDO|5+jv_) zEc?>HX($&(*p7!5>sF&^sNlWOrpnG8qO}XK(zX*fImhTe1D6iHxfD<$9uxy1nTg|F zJ6J*J4?!bF21o1u1&QL3W{a*{q#$HMvJfK!qjek-rnJ!(m5* zoMxG>2GR&wa)l*YEd`Pm#i2DIQF-u*wsC1E=d+N~`a$Z^U|9i)+7>g+Ia+%W(omYC zS|c7ey(I2ymD4rDRBWh)b^)YJ$>Jioc4Am?jLroe0vA*>G))Sm46()`M#sTX@5oJa z0unV8HBGe68*`KDFH55#^-(?O_Cr$q`E;;?K%rVvBeDpwAjY5@39qtl8(gi11S3?N z8t*Km?vQLG`x9b8tU(tOBM9g|6n4ixT2}xmtwGuWiGq~VY9L`vRU|zMF-emkb!$l5 z_f(o$oFL$#qU1}4WXd-mQes2eQAqg7@#%E&a_LgEx_n4vDaXE6yk;=y?m$PrP=CK@ zT{lBx=`%=F6FJR3K@c#;usDx*iq;t*(J02?L#xb&M1u&;?H0`riR%*$x_ao~z-T88 zmv|IRLkYRjrn4cDFKK}2K7d3mtQ8{@qFJqYt+PQF0C#vALAT8(T9*e2&oKBJ?;fo? z1c_Qh8kSlcupMd0*d~FaIm85Yo?~V?z6LE#TheMkHe&VmP(1Yo;RaH$Lb%3gLXyP7 zq;)8rUc?tZR&R2Kpye;tqiuDsdsGRWFH~3=Ypb z*nI{LPc(2%Fjiz;e{h2(-41a5y!hv0fk+!RdsDa5flu^`o;>E5GqLu#s~+yxb% z2eJSy0GWYA5M6}SM2i*VKrLuFh_1gvYStAX^0N{|*GlRBG@3(Kfz6CS8POj1^&6p0#a6Q+$aD)MIWH(0~HJcO8aYK$S_1wJdGMLIMYvz&2$$>XF5oI6{=V@ zMpCs_^n~`1V}KM^9FW?p3y?}l2GT`H=_v}P0%>k#0I6F2fiy=3E9pa-GFOH{fuAs3 zF~}tWS7Rhq9&VPv(Lj>N&`m*NixvG?MgQ+n8LMPSk&jofRB_N4NmYg$q4JlCgp_ZR zVozuVxg1C>_8O3qUZBnJ`B~p~d^9ETQRRVgC)~<^m_2Y$mm%(JF8SqG zFYeyq(_WU*&X<0%OFVO+<>A-&?*6*=jN#Hr>#hqd-Z1O8zpe9<{zbh9><_p)ee8;G z+h!FX(<6cjPwbxnUzS%O>2BUGcvjJ>gZUM;$73v}m(CpU;Oob?4~>q_?-R4~x4jj8 zYf@Uqdw*w9;j#JQFxPogq8!}(9+s@DjQwQ4{p#hmM?N|*wKD8wf0i)!#&w=i$k*>X zcW&$l|N4E}*2Pwvs}tf1nhluapYZJkJAD~?HOOP>`{Utupk43tR&PCdr!Z)Q zkamdOKYLm8M3+0xBY$XO?&Kaddy0M2K0nr@u;SLOiHA<>MV}S!<&H7h(&{yxR&>}D z@Z7DliQjkXyX2*JwzZyaVO-?YchaZhmIb$)SsowN>XX3B@9iu5_HbqY(>2<(^yqaK zc@{?d?9+{U^+4k~?qB?2!jL`lhwj_@tyRH|*v>OOW@T+~V$*&o2#o8Vlz1z*W|`&S z3D0}Pd0yS(Ja1}o)Yh3__C7YLd0u($rsDPbq1P*qtyo~5aOcVIo%{!0U()5>wx_`u&17{EZ-mXy{Pd2XOZ@S{Wt-g9`>ZL>17B*RNy{>56 z-KEw?-gx;*eG6Vxe6erN;rTVr9lbs3r>34-=zPs-<)wWQ7d=FA*vhTJ0p(-*FA|?y z?Jn+Im4?4G+3GCOs=`*xTb;(f7q>y$1kj{yYYqCW5_iV)p zYtq;Su^Q4LNWt%=u}k9k_p-#vYi-4okbV*a)@F$<*4c_LtxaQB#IGQohSYvt8oMga zT$d%zU2iL1fpkrbT%RR&*kCIzUZ2Kph?gM!0;%hUG*%-n+>k|Y{J7t$Ox)PTLaTSh zpW))n?V;k|2nLE&h`)!^gUkj`-KgK`L&Xy_IO(W?ngX-@q`G zJ;M4yjock6wc`F8v4dsdNxgiL^dktpCvEo|%d|++MwhOiKx9Mv(pNxqT?UbEaxF=C z6RH#KZU>5GH~X+T;(?pxLudy*5mW}E_om-Lk3sby%1Jx%5)f^Whl8>~BS1MIdQYL( zawO$@O;o$?&b`b6Nji8yJ7sQUYg0!!I zdsQ5A%P*iQxF#T55WP9lOAEcgya}HEZKxEN-tro_3z`-ndUI&})|ETnbm9PQSfnH{Dc|W9v$HV33&d;x z@@n}S6!b889YoDXJR$vkvPhAsNf%Ux-Tjhz(Cj@8It983x(*_r-;0j-oy&g#cL8)3 zbRI;5;3DWM=x5Ls5Dk`dAR1VgKtF(JgH3rTFXf|j;t5HAQQ=8e(^UVBO(l=H#nJ&t|!4h-6dM~1f( z1obT z{M~D&lu$m%oV8```RnE^lIeLh9BCpW_*rx2#SHvcBx>OQge7xlFYq=N%!7%1n3j2X zsoy)THn;wCk>irx8rBx!MCviKd9@pJ)e?J%Z-TA2dOG3uwn_blIUU|)vQ>QZM_T6j zhk_c!d;A?Ml$*h)TOicId>chkz>feLY-aI#h*9dXh2R74^=|G}Xf8F9zFl|+K|R>; zbLLdD=lU+KQd6P@i>ADXCDS*!%I9xcB4+i(!}6HUZAqHKFuShm(32X|U3eDCDnNBbZ~n+Pa}Nz0}hV=g)t3(WA&-Uqt1Z4AfH~p9r$*!1hfkAuq zph~a!6QSNdj%!T@>QNS3x1?)tZ=U$MDP;?POup5#FQbRAs{d}`hlwVGvpmukF>K&z zw&Z*rIDud03 zMEvrSv&kZrGdro@y#QY7p_B(hm(FOn{EK>%-DaKvgDCYFOLX&19rVAQNH!U$2VEA; z^d2x{;=LB86o+8`wjF{{kH#1*d*+wSJ)CQ@=*GXIAaeN)3PL?vGq>ce=I7>iw>8;a z<$m_CtLKT1tf?1PJoU`V^))M_-ai}freRouvA*)#4$Q+BO{1QA`6#G5qWg<4zN8x9 zybOQWo;5Xx%~M{@;dLwT>55`xy_a-g22-a}b9r`lYDy~&26Vgdwpeau7g#LkIxug= zoIS&@FZ`+}Yi4;+b-vlhxh@zD$@4>e6ZO+VtmpNj&v}nT@ zIAYybkG{M+}zb*XZ+m(7a#^%Pb-p|K1xnxS|%+EQZ&DBFZ86UpA!}DaH z0vJTeSx0e4Cp5+k9_oZgfI|cy?u5Qn4+DK}+<5ZMZEMlBv()q7 zDVuu4$HRW{&?bfR8f9zE+n_#p(sXymke6%cr5+)AvG41n?pe0{1f{f-qmm8S34Vlf zDUuBB)pJE7W30AJ8~aj6Q(frjkvnx|h@0yxZ{@siN>K`YcGjng@KTQ=RX?~|UGezS z#c-sT1MA1XbiuNqo?Y^+%?j^)f9wO3!Lw7QaUWNy?$YR!+mXNMiVn7M;wxS8;BCge zyjZAC-$_0R6vJyMLn_D4v@HweeF5$JBGDRkJoBC1)K&csPQyx%kJEGwQ&O(^4j*J^ z?;nR0+BD!Q;2)8P5`L#CT5}q=aYGecW8`x@zmC*ySn7H7j0>}dh8{2K(WvoJzulbm z^S?fDU@ej2gcNCK;Ob9q|9V>>73jnr+)*28|KO@6m9$gvV1K(yFlCh<(UJ?fJjum9 zzQse{2S_Q;+9a3~8$FJ*Jy83G$1(YlAGUH${(9453dfx{^^`X)lJiMC%@f;(hT~sR zzvs=E-|Yu^+t4T%lMQM2fP7y3OHXDWq;{=(C@jC{@sJXyF-I_dFp zZ(2NEgB@oE^*-vtLc8*}eVBVzC{k#=bqDHz&%4JwDwxwJpDg4Q`81ede0X+(`H-6U zC>ItV=O5`G>)%#ASN7_JX=84dyj-iH=O~sHyaVz}eyH6S{J8+Y1)k^&xW|10F|KTq zd4xZ@(-xw`a{hWqo)&};rZ#T zYL@??-Ts62QiFZEotWGjnyKl0To7|F{NreGU`x{FQKFtFoEYGGFy*sd-lmlQCXZ5{ zw|ctp^YA&{vhtmen})Aqq3P9???YtPqm)<3bs_v>5KF*cHFyEXl1tm}=kF!C2VAe( z@Fry1j`v*5i%<9rirxqrUl)x();`?RYDe9~-H@9?zBRWxf1h{Efzyi50TZeUo3WQ1 zW7=clmW`a6kUKV~G%vd(XH*-UwQeL8mL?SBj4dw6pAuGBI<~k?X~CFrqw~T@SLG1J zQarI+8IZ}Mb+8#Zp=83CY;MeCo?PFPdGjwbu?&5Z$^v+gp3H(f_GI7k1)0p6C-%ZC zhn^4a#kTN>Ud)nT>B$25kG)tYrmynp&9MK8;_v0KzJT9zuy!W4XMt5KbJ;L6$zSZV uVk&JD);Pq{FzF3CQmUeorwwO=n7^x9tu}PnoU##e|4Z#<7(KdZ!pK}{g4*E75u=Ns zlk8?ma)sgW{=-M)50s>lkg0*mymPgB#ruLJ2_9_gfWE-_Di*7luVPmqBCw?ZshbT| zG^?mr@itqqrlXKq9c$J9RsWl^i=T< z3dzA&K+^97QbS9Ch{ZM+NH=u!;QXQa7!+^gZq$H$F;W=_3mPibnBV|DfRVL zyRmus1-bAyC{FRW9Y~o92hs?d6)#E6$iZYV)Swp%=-#*hX~f)!ReIPtLAm$IDuw~6 zUJl=E@GJfrRy2YR0%=_Ns?F=vaIT{p6yAUVBgPCbf=4gK`>_6nL!*a`mONFtsDDmQ z|D1x{U(tQ)#@I2rQ3G>_p=(`su8qviui|ciOCz1JH#&~A+8FQbVKFXMB^@vGwiv&M)C6UE?ipfXQM@G7Y8ZpW zH|3?FNruPZGI^;_5=-ap>RQ<*UQ*X;a6vv=%dHiFYbkT@fs-RJ{tT`$JXYhKeJzFt z$f2xflejV5%0A@n@ZXu2;C~YTJltwnh^%LEQ%I8T7k{1}(cIVv>7$Skps$6^=buMd z4JV+p@I&>IX(jEzP4$ut5tyx+GFMo|eN@G{;@)QRLy^gPFzK?{a&T!f_hS_ogR!FM z##eEBt2mbst+Z1Wx3G%)9$XtGlsXz$Aam^-Bu?nX6u3E6oQt zNY)(zmn(A#f03kqGWTW`cL$u}uTul9bR#$=0v9aJ*>a73;F5T$Uy^ANxOf_35~drU z;vUKOy1SU_Hk72~XSK$D&|2gHahZ<+*c z*JritEH}nmb>Y!GJ-)dq8>=eTv8Tf^u7EaOaqeL;jKvDvh##t%WLyg_6M8+Tfa+lb z=?SSCFY~b&r$BlUl8$!{w-~>LL`^GmCn{EwIze)xxnrCRsXZhU_w=+F6XNjHA(v6N ziontg)XQ`37^ECULJJAVTN)&T+};XE)SeUXj94B*qIynpS#l$c{VK~@kSMvBXEiN` z1CaXCOf}?T|H+cMof>C!#e}Ttg<&kDPO`-TaE*BT@Fe3y;@}NELvEsRe>!rLXOeL; zIJ!MbZni_BOewk1VU|+=6)6i+SIvWQ6(q$U_2VQYiq)C2$b5N8lGWHAZWY~8WT6BS zj3}4L-abg}Ai2r*+j&W{)mSGa5fWBhRayjzqEyO`LBeXSN@g_TkorJs zTUGYXQ)O2mVS7>QHEi}|y-|=_RF!Rkgg+%d<1Mh%x*V-Bv$`NGPM}sZK3`p1w;iJrKF}??h zvLKH~LnWj{8Y`v-P}1yqYKrTMT5;FZ=DOXjczSAcLnUmQaZ_rNZeweH5Q>5DJD49z zO)^w~O9y9VePy`_cOgsW4uHc_4I3}So+fiW!6~{`;CjnC9Y(~9N+~#{?s{;F-FnpoIMKu(}JplYCbAi4;3pf^=q05pL93Zmg6R4^7C*1x zf23F2|AWXJ0eFGErilM_EdEa%(^#nl(Ji|JqFeDZh^{A*%I|{cRy+Wa-9r#vgz$s@ zL+b{?jY?IdiY8V5XGmkj7j|TCRxtobRRi&l8m^`4LsWeo6+?mYeoYJ+hRcelksQ}k z^@POMr+<7yr`r6hP97A2)Iio8?^L_k9a2+BR4*AwnQ93n|EXl9B9*sQ?b-opR&@Z9 zyKErMj$UecA0YmuzAE+uQuzQ6sU%T#12z&xT^pEAO$`W^$69U zL!Ln8Zc3w7gE49Ygf6Hs8Aus=9Y{r`^iM^~&|Fm}qz2{zNk3oJ6B4^XMFFHt{1r%c zOFOFt%T!#h7Q79lG4>viE<&oX8AuJ;RotfH4j^4SnEmC9fIk;WB^$qAJ^x4gKNm?F z_J1yt7;YVqh(8xens@*4BH0Nkr1kB;wn*A1^sMkraT{{v`kio7&*huTzZ{xTvYpN7 zQNHoktJMeRJUrPuefZIVIVT&2)oRP`PI_1tSe$$->dM0W*8@tNQycpC-M?YIpMCnM zBYwq?&txp9S@59Mtdt10y>E|A#m5VKKRTV$pku+@O(BI-_qaV?)Mf0Dj2}!Fl6U!s z+g-a29US=4R}-_(G;Q3^J+OkyeS7Tw7+6ACQZK!q`=O1S+xYr-S~ITl(1K()w~@T8 z+2ZA2O*#KVp4+&rAA847DrtLqfd6-8r5o0Ln^%(Dx4(Z}L|EGX!*4$DZdkkCC-xg9 zAuQ!mNVhiv_n2lU1O>AO`#bwK=)Au9wYAB)J(}G28*uhvkyrE8ma>Yq-q~;U9hq5S z`8oLHBA;I8Odd`p(?)z|e;m)-&o*bWb5VX%78kZ(vNvF=Ps@d`>|Oi!!%ICky*fNK z+IRN*r@t=R9J@NAu=v=#*HXHVT2=r3pifVge>%Cdug}}n=A2>=p6ufs-eYz)cX{2! zKb)P>zD(;bP@nNd^@+1~ACF7vb#=zQiHY6TteElR(a5z|tM{C;EMVi5jrXD-zUDP) zh<@6fd1rsCbNu+$2_7%5+qw9HiDyg+sONpdzTx%T9x2PJ-@mkcRM5rXL5&w$kB_U_ zeR|VsSC)TX`lg@LvbF_X%y!|{Wbaa+A0L14!|4sD4o*l2vwqY5_?<1;-fr)lKAX0T zf49V3+$ZdW3%fqO&uW^R?ozAg z8v_Em@49`gLH4b;>PIz5SoDR5{~e2c?3ZcfZQ8a8-?zopDR@hpodt0l>Xg50FI_rU zpTc*(o;Z6(N{#K2Qgqk_W}7^-#YZEoU#xJRkoiG1r!1*@+|@J5*T)UoWm+S8uMT+2 zx}w>rFE5X_9eOu($=d7}Dx23|W#ShheaB;0XY+3$&0n2?AAHV1nz`Dj(H#+g%Kqb@5O~UbgIAthamYF4D_IoA$UEUc=8u9&!V7-CgXr z_wk>UP)Ac=wWO_iOr$@TZfk;OWZ?i#kod=O_ z{B@Er@^5qBpF(-j&91!S=A<6di13fjJ;>~Vb z*~fhH?OwTiAnyh31I-7m0<8wE0j&ou1C@hTfU-d^f_i{@g1Uk5Lz(=%x)m*M0?|YD zE1+VK4Kx)rjVD&tWi@#J%G$y7UR53R0QKk%fZhrOczSu?!pkcIdv1q@UT)|`s4gfB z6a)$e`GM$tfnMpCfR=*tKtn)7K@lkP2fYBkDd=5L%x(O`Rs9~_2#mJGpH47#+3xf6 zS(f?+3Q9q=I#U{-OsS@uqn6Ko!iIi}(CWQmPrQ4W`Fsu4anM!JkD$w-6TI?n&EiYo zz5`M2PlITPoB>?~T>$+6ItMxh`W|!^bQ1Ipi0V*Xsz>F-6Ox{M5U-JDNB%Wi)GL0f zf))T76FnQ077#i39z?-VAXh*qK;&FQ($Neeq~V@&5C3p|P4^9#YjUr+#(j9)gZ8!J zqZ{F;@bUOOgRj9+=?79rMUSYZV|^P%$Hhj+*q1!G>=tXnkh!{YdE@n`n){(BHaadY zI!4kyQGHM{W9G&ZU0p}X+v2c+`4z`V+SjccSBH5A51D$NOd3U_zNCHsI#KgLy$**y zT!xYa6d)Gu1DpPubNr~w$6i5+CAv{`V@c9JoXP= zu-YfZQH>v6pLXfac1JVeqK-3**In`yDK2n1Sd4IH{%nFc>d$;?BMeFVsOa)u!%yaU zF4(1GYJk!r@gZyj-@}hIuE^%Ha9hL3>A5-HtN{gqOD`&6p!pVIE-XM3)P}0WQ=&Y8 z`536d1hLu$y=p1?yCRZ~Vk1DaOVADr_}09XS$}5QK6Jzq9hZPqYR3h_KV8+OUf>YD zQbN5yDEb)T;<}F*Z)9a0cxK`j2jDJc9G$xb5BnfmpE`*}7U z@31Quwn(N|tP?F@!1jq=1ark0cNU+Z9g5iP?d#QN&RbLUOkQO$ zjyF=oz7vQ4!4N{zTqQkMmstc?n z9|FN(*1nJHm{KA-)MWm(@M%LkP2yK^Gc}`o8CFEC>Qhay1!AIKRl9-zvepsN9`Tu< zXD43qVnI)L!mJ%fndU#J;$Xdg0hsrR(J|5Sa;Q!IX{gWZCH7%Tkgp!K7YKJ><}a4k zWC01ye z@@^Q!Di%#e9dBf)gGeG6D7txLyxzs*iW&LuIh2LP#Z7(5(UNw`=5Mxj#}{s1`GTV* zC1$!g+L4#73%bnTzrBKN8Y$6yEh^zYP&+|0Z0O6CW9`{rINZAks}I7}j@;a|CVW2L zu&qA~5)=>NVzdv|H6<-o3> z879ucBv3oy)41)uw@*B%z1R_NXAwo?ONAWK)=v&j9&}1V#5z9~9QgZvIyP3`r6pI9 z8q6Y%W;`4kk?}gh&kPqaB7?wF6axa2P)M8S$**g?yrTPoN#3k4o(kwn6^G1dzoWQJ z<}Zpsf9BsY2j(6y@AR5w_QJl4=EK~gm_I^^H%jgeGOT?opyH%AyA6#SG|%q+9?U&S z*$d>&-p7Ck6ls=N0{`mH=Pix|Fun2+;LjF`Ybg3x+q{nxxlwjdrM}1tsM_yUk54ox z?~>0n_)m6z#lgR`70(Vtx}MyM{gr)J>8HFS|3R!NLC?l2Z~jUp`AOlKSe4@6clvG+ z^QyY#^@V3J?qRZsBv8gfEp0q#r>!P9{`6MzVYr6lMEIWFS~=+z;1ljSrEZrBZ#DrMJRjQBqh8Y7%io;wpS%A} zM~Q$1O^=D@q=)&hbEN?Apg)noVc08+e%%ox03rlY5Xp64A|(`&Xa~!V_h>Xd?abG!92V8Y2(+D`9aS5z+xf z=Ko)&uK4*0(vIQXn7e8172}yg$AElxBzmw58OjLMj{J?S<8vTw|IQ#s$#d!?VhBFJ z((^-DlqtRpXXfV5x6n=tJ~%Z--{(g2#vZJBvyj-3<;<-%?G<1Z2f8Ma>%}rZ_V77_fb&Nr*l<* z{R($%iD1(`t6^G-rcGGLj-n>4O#rr@-C4{c+`3>XI-iASj}}c?kcjPqH^|VQEJSSV z!koqEF6=82+Kq)Ox|lA^C{ntzNYpOq$~KB&-Iynf*-_k$&GcXi!X=M&1N6;fQ(3}} Vb9u~GO{sXOkh$#$8_Ev3{vQ~d`JDg& diff --git a/docs/de/app/features.md b/docs/de/app/features.md index 45285263..ebf3bab8 100644 --- a/docs/de/app/features.md +++ b/docs/de/app/features.md @@ -37,3 +37,7 @@ Greife mit einem Tap auf wichtige Uni-Plattformen wie Moodle, PRIMUSS oder dein Bleib up-to-date mit den neuesten News von der THI. \ Und vieles mehr – regelmäßige Updates basierend auf eurem Feedback sind schon in Arbeit! + +## Änderungsprotokoll + +Jedes Update bringt neue Funktionen, Verbesserungen und Fehlerbehebungen. Schau dir das [Änderungsprotokoll](https://github.com/neuland-ingolstadt/neuland.app-native/blob/main/CHANGELOG.md) auf GitHub an, um eine detaillierte Übersicht über die Änderungen in jeder Version zu erhalten. diff --git a/docs/de/app/setup.md b/docs/de/app/setup.md index a2fd75ad..2039d8fd 100644 --- a/docs/de/app/setup.md +++ b/docs/de/app/setup.md @@ -11,7 +11,7 @@ 3. Installiere die benötigten Abhängigkeiten: - - [Node.js](https://nodejs.org/en/) 18 LTS oder höher + - [Node.js](https://nodejs.org/en/) 22 LTS oder höher - [Bun](https://bun.sh) oder nutze npm, wenn du die Abhängigkeiten nicht änderst - [Watchman](https://facebook.github.io/watchman/docs/install) (für Linux- oder macOS-Nutzer) @@ -33,7 +33,16 @@ - Folge der [offiziellen Anleitung](https://docs.expo.dev/workflow/ios-simulator/), um den iOS-Simulator einzurichten. -7. Erstelle einen Entwicklungsbuild für deine gewünschte Plattform. +7. Kopiere die `.env.local.example` Datei in `.env.local` und fülle die Variablen aus. + \ + Siehe die [Hinweise](/app/contribute#entwickler) zum API-Schlüssel. + +```env +EXPO_PUBLIC_THI_API_KEY=abc123 // [!code --] +EXPO_PUBLIC_THI_API_KEY=SUPER_SECRET_API_KEY // [!code ++] +``` + +8. Erstelle einen Entwicklungsbuild für deine gewünschte Plattform. ```sh bun ios @@ -42,7 +51,7 @@ ::: warning Hinweis -Schritt 7 ist jedes Mal erforderlich, wenn die Abhängigkeiten aktualisiert werden. +Schritt 8 ist jedes Mal erforderlich, wenn die Abhängigkeiten aktualisiert werden. ::: @@ -60,9 +69,9 @@ Dies ermöglicht es dir, die App mit dem zuvor erstellten Entwicklungs-Build aus ## Änderungen commiten -1. Committe deine Änderungen in deinen Branch. Um beschreibende Commit-Nachrichten zu gewährleisten, empfehlen wir die Verwendung des Angular Commit-Nachricht-Stils. +1. Committe deine Änderungen in deinen Branch. Um beschreibende Commit-Nachrichten und das automatische Erstellen des Changelogs zu gewährleisten, empfehlen wir die Verwendung des Angular Commit-Nachricht-Stils. 2. Erstelle einen Pull-Request von deinem Branch zum Develop-Branch dieses Repositories. -3. Gib einen klaren und beschreibenden Titel sowie eine Beschreibung für deine Pull-Request an, welcher die vorgenommenen Änderungen zusammenfasst. +3. Gib einen klaren und beschreibenden Titel sowie eine Beschreibung für deine Pull-Request an, welcher die vorgenommenen Änderungen zusammenfasst. Verwende ebenfalls den Angular Commit-Nachricht-Stil für den Pull-Request-Titel. 4. Sobald dein Pull-Request eingereicht ist, wird unser Team deine Änderungen überprüfen und dir ein Feedback geben und gegebenenfalls weitere Änderungen anfordern. ::: details Details zum Angular Commit-Nachricht-Stil @@ -89,7 +98,7 @@ Dies ermöglicht es dir, die App mit dem zuvor erstellten Entwicklungs-Build aus - Verwende aussagekräftige Variablen- und Funktionsnamen, um die Lesbarkeit des Codes zu verbessern. - Dokumentiere deinen Code bei Bedarf mit Inline-Kommentaren. -Wir verwenden den **Husky** Git-Hook, um Commits automatisch gemäß den ESLint-Regeln zu korrigieren und sie mit Prettier zu formatieren. +Wir verwenden den **Husky** Git-Hook, um Commits automatisch gemäß den ESLint-Regeln zu korrigieren, sie mit Prettier zu formatieren und den Commit-Nachrichten-Stil zu überprüfen. Du kannst diese Befehle aber auch manuell ausführen: - `bun lint` um nach Linting-Fehlern zu suchen diff --git a/docs/de/index.md b/docs/de/index.md index 2d0f8672..2b8ade2e 100644 --- a/docs/de/index.md +++ b/docs/de/index.md @@ -22,19 +22,25 @@ features: - title: Stundenplan & Prüfungen icon: 📆 details: Dein persönlicher Stundenplan aus PRIMUSS und deine Prüfungen auf einen Blick. + link: /app/features#stundenplan-prufungen - title: Kalender & Events icon: 🎉 details: Alle wichtigen Semestertermine, Campus-Events und Hochschulsport an einem Ort. Verpasse nie wieder eine Frist oder ein Event. + link: /app/features#kalender-events - title: Profil icon: 👤 details: Sieh dir deine Noten an, prüfe dein Druckerguthaben und erfahre vieles mehr über dein Studium. + link: /app/features#profil - title: Mensa icon: 🍽 details: Schau dir den Speiseplan der Mensa an, inklusive Allergie- und Nährwertinformationen sowie persönlicher Vorlieben. + link: /app/features#mensa - title: Campusplan icon: 🗺 details: Finde verfügbare Räume und erkunde den Campus mit intelligenten Vorschlägen und integrierter Suche. + link: /app/features#campusplan - title: Bibliothek icon: 📚 details: Reserviere einen Platz direkt in der App oder nutze deinen Bibliotheksausweis, um Bücher an den Terminals auszuleihen. + link: /app/features#bibliothek --- diff --git a/docs/en/app/features.md b/docs/en/app/features.md index a915429d..6d164e9c 100644 --- a/docs/en/app/features.md +++ b/docs/en/app/features.md @@ -36,3 +36,7 @@ Access key university platforms such as moodle, PRIMUSS or your webmail with a s Stay up to date with the **latest news** from the THI. \ And more - regular updates based on feedback are on their way! + +## Changelog + +Each update brings new features, improvements and bug fixes. Check out the [change log](https://github.com/neuland-ingolstadt/neuland.app-native/blob/main/CHANGELOG.md) on GitHub for a detailed overview of the changes in each version. \ No newline at end of file diff --git a/docs/en/app/setup.md b/docs/en/app/setup.md index ab53af1e..0f4498f6 100644 --- a/docs/en/app/setup.md +++ b/docs/en/app/setup.md @@ -11,7 +11,7 @@ 3. Install the required dependencies: - - [Node.js](https://nodejs.org/en/) 18 LTS or higher + - [Node.js](https://nodejs.org/en/) 22 LTS or higher - [Bun](https://bun.sh) or use npm if you dont't change dependencies - [Watchman](https://facebook.github.io/watchman/docs/install) (for Linux or macOS users) @@ -33,7 +33,16 @@ - Follow the [official guide](https://docs.expo.dev/workflow/ios-simulator/) to set up the iOS simulator. -7. Create a development build for your desired platform. +7. Copy the `.env.local.example` file to `.env.local` and fill in the variables. + \ + See the [notes](/app/contribute#developer) on the API key. + +```env +EXPO_PUBLIC_THI_API_KEY=abc123 // [!code --] +EXPO_PUBLIC_THI_API_KEY=SUPER_SECRET_API_KEY // [!code ++] +``` + +8. Create a development build for your desired platform. ```sh bun ios @@ -42,7 +51,7 @@ ::: warning Note -Step 7 is required every time the dependencies are updated. +Step 8 is required every time the dependencies are updated. ::: @@ -60,9 +69,9 @@ Step 7 is required every time the dependencies are updated. ## Submitting Changes -1. Commit your changes to your branch. To ensure descriptive commit messages, we recommend using the Angular commit message style for your commit messages. +1. Commit your changes to your branch. To ensure descriptive commit messages and automatic changelog generation, we require using the Angular commit message style for your commit messages. 2. Create a pull request from your branch to the develop branch of this repository. -3. Provide a clear and descriptive title and description for your pull request, summarizing the changes you made. +3. Provide a clear and descriptive title and description for your pull request, summarizing the changes you made. Also make sure use the Angular commit message style for the pull request title. 4. Once your pull request is submitted, our team will review your changes and provide feedback or request further modifications if needed. ::: details Details on the Angular commit message style @@ -93,7 +102,7 @@ Step 7 is required every time the dependencies are updated. - Use meaningful variable and function names to improve code readability. - Document your code when necessary using inline comments. -We use the **Husky** git hook to automatically fix commits according to ESLint rules and format them using Prettier. +We use the **Husky** git hook to automatically fix commits according to ESLint rules, format them using Prettier and to enforce the commit message style. But you can also run these commands manually: - `bun lint` to check for linting errors diff --git a/docs/en/index.md b/docs/en/index.md index 97540d44..019efbbc 100644 --- a/docs/en/index.md +++ b/docs/en/index.md @@ -23,19 +23,25 @@ features: - title: Timetable & Exams icon: 📆 details: Your personal timetable from PRIMUSS and your exams at a glance. + link: /en/app/features#timetable-exams - title: Calendar & Events icon: 🎉 details: All important semester dates, Campus events and university sports in one place. Never miss a deadline or event again. + link: /en/app/features#calendar-events - title: Profile icon: 👤 details: View your grades, printer credits and much more information about your studies. + link: /en/app/features#profile - title: Cafeteria icon: 🍽 details: Check the cafeteria menu, including allergen and nutritional information as well as personal preferences. + link: /en/app/features#cafeteria - title: Campus Map icon: 🗺 details: Find available rooms and explore the campus with smart suggestions and integrated search. + link: /en/app/features#campus-map - title: Library icon: 📚 details: Reserve a seat directly from the app, or use your library ID to check out at the terminals. + link: /en/app/features#library --- diff --git a/docs/package.json b/docs/package.json index e35e7f42..16d890fc 100644 --- a/docs/package.json +++ b/docs/package.json @@ -9,7 +9,7 @@ }, "devDependencies": { "prettier": "3.3.3", - "vitepress": "^1.4.1" + "vitepress": "^1.5.0" }, "scripts": { "docs:dev": "vitepress dev",