From 34b1fcad722b996f9c2953645e9dfeb462ed5f6d Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 7 Oct 2025 15:06:45 +0100 Subject: [PATCH 01/13] initial document page --- docs/assets/logo.png | Bin 0 -> 14600 bytes docs/cluster/README.md | 1 + docs/core/README.md | 1 + docs/database/README.md | 1 + docs/hardware/README.md | 1 + docs/index.md | 31 +++++++++++++++++ docs/jobs/README.md | 1 + docs/services/README.md | 1 + mkdocs.yml | 72 ++++++++++++++++++++++++++++++++++++++++ 9 files changed, 109 insertions(+) create mode 100644 docs/assets/logo.png create mode 120000 docs/cluster/README.md create mode 120000 docs/core/README.md create mode 120000 docs/database/README.md create mode 120000 docs/hardware/README.md create mode 100644 docs/index.md create mode 120000 docs/jobs/README.md create mode 120000 docs/services/README.md create mode 100644 mkdocs.yml diff --git a/docs/assets/logo.png b/docs/assets/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..1ec9404920656322ba193947f4f2481aebaa28c7 GIT binary patch literal 14600 zcmZ{qb9iN4lju)ucg&7$yJH(CwmP=$q+{E*ZQHgwNym0_`~Bv-Gjr#eyU(-Es$EsT zs#R;(AN%aH!xiMj5nyp(0RRAkq=bml-x>IK$U#H?{Vv3rs|Nt!`7MNn6(og)i4+`c zO)acU004>bBy}jD@)$<8R(x#itWXN72bxGBcr2sQ@noCh1R&QZlLq5B9|v$4 z4ohnP9po1iRT;bzk{|#@0R+L^(f!3xO-2UXkKOIFqpJh4D^JHh(c+`wt0$dYFLnkD z5bn>Jl`}ID_zVEJvB}d?0sJTr=!(CEnP9Q!()q&(bxMS=ptov#x~C}!S0Ndiq3BV93TA=S+3IeS@()@dZwL`G4KjP1z9Mm_`7X#1 z&L29kgw`6;J1E0^`yJ`nw(vRQ@NPRXk%Ty08xoaH1{0Mqg}r=XI$daoT`aUoBNY=7 z0)*Q~66)S0G)#;qLy%Q@E)eVVVz0!W4PH%~L4Xfkh2Ga!v{4C)m!Cm~bR-I)0nehQ z-6a*QM7kmV;iJ$wZ&qNel*x>-9{b&(A@NgAVbrH()!2alEpiMsooLFr?H=4*-W^h;gIiQzlXtT}?RMD_g={T^J zh)9kJqa@7HDDktkjfg{JI79e6T@R}UFOmYi7ou!-gk=zd2_}N~Cf~{i_=}j(iz^IZ zg$#`)2&=`N3SRGDThLO6sY~S%0D>tYNRA8;Cu89x*4QQq7;#eo{|u4<+=dQAjCw-k zBH!wT0*B^Mj7L4;jz}DO(ZcQoIY)z6lwK(36dFmdv6%aPMUMN217Cjklb?M(y%W7< z8T=p@8k2w`VP1sd3;!`FXh_MFY95Na-`&bV021?A+qNsS>1ao=^8q6dofQ-sWEn)? zUlrc(9-mYH3tUG*0H_gpPiX0{B`nLq3wZMXqkz3Kgy2td342g$CxEqvP;X_jU0=@V zGyk~(@6(DaB~Z_TO?DRdG1e>)qtc-6h^rL0^g8lN=^#s3&f!^leEfV)SUwYae4WEr zC%Wo$4(|fW6N=x50|I8*mtN~~UJ8#?RXuXM#D+yDmo1ODi1JCYy_=P!%DmGy-8S+P znO`HwsQMTUc`mtcfofo?1`-I-0}To(KIn)uZD;Rd4<`8Nt=QSUJviQj8)oz7YV%15 zcy5G;hsXPz4sHU}u7L4>hITtP%RHYdK&sI??-L+fu2kfB!xt3%BkoSVF_P?|O zTz3)Pe;`AH%@KhV`oS>1(Y8*L>BFXi{0=ZwfK3iu%0;yTWc0bz!kvRf?Lu>c$OXdf zqP9X__AV_T==$+rBYKG;2L;U{a~t}l603!Q?FTTT=#fH)3+~5$BSjb!5efU2=07Pe z6~|nNx)!uZ>=`FK3Ui1zAHFF>K*Tp{d59K~r=o((CRR0vLWyRQw`UH@O)w=wQ6PE( z>O`gKznsf62YC&YCs0$QVU!%n!4uK z>uayoJtvVHJmmy)4Wi-vCO_!@Z0v>64PGjUBI_q4YI%^HBx=f5kui#&|X z45JJ^6y(sa*8iiQ>Y3IVZ5t(AL?<6%4vasNYS3!mX&-f;d*5c?-jL!3r7lN=7&{hE zg1^ulHAO{`n!Jkag0v}?KA~NbP(?*mMpauSKvhXqg!)cpT-Bu%Pr0q~R^^CABhX6p zkyt$8<!E3V0BjcI+#JF7> zZ}1kf#V!tFmVBn=8IWozUOhz&Ep*?))szMFK-*lEZGGSV^As%bQ8-fN_5 zifK;QRyK56i#8i-nrKwjaT`5suMcytdE_}4Jh0$;<3`KI$!1OIXr))>To`ZQY*e_2 z@D%GrZ*g}>KbCf7cqe-&eTYIW_HF$*sh!Sq4hB8sQ#+l53Yk zk-N*p$E`O-I_9>u?`Bc5G+rHbC&>`+cBymSYg1{{#uvp!=l%Iu zTC7;3jjs(+eWqjEKDR}@h0)&B?(O_!m(se@@#F^dD0Elx+|>WcVw5VKYQ_hX4U*l! z7vtu0@9;!@y?*?V(o*0W{e*aBR$wg#CuWQNF*>ptde$&jGLf>E@w;QLWnyMB=1l$I zX?CYS=c;Gvi)tb|X=;7U1A7;b2!<2uI{RWMdyJnT3?c+P8QcZj0)h-u6>^bf`BnFq?BrqUK;7VK>T3Bag+0lE>0nlP$%y=~9h5Kn??eU~{aGR# zA{K_0@gDQ7h3kb+WBy|%V>(7+ztXsV3q=@2FcwiIC8j5~vo-lz&8{vPb&Rw{(Ga+L zcTPQ*9n8owX2$aDorpYyZ-&1uKwFGi@XUAH6|}K!emco{IC~JrOlb{x_B|cf>_0(! zftv)BVDn>}V9zjnGpn0E8o!t%nLWU+^-JwloX?&ktX(e6)C6z>xRU{HA@s;pD|_>v0C(fbD3;n>v=>W`V&>N*3H z*5FNVVl%zDbIdhElkw!@bNl`qVi@i>t=qlyD1-CR&!PBzT(~Yw8(J zwy*aGruS#Z&ML@U-l#a*Ilf zzFME%uEHnLVl*k5x4F1}A1*boHb*P(l}u+N@_XOHpUF&UVy(v;LVRO_~4I9J_y>_2313~!yZ zkM+Eqt6f&9x4_x@cC#GQ@7av;MR^`QMP07E8$69%(mz!fAb}D#3jFeQJ4U&hiyV20 z>2YFk6Y^C0T)elqU`a6(_XzN$=OcXUd<%XaI^NzFVEd}{v3R@f)%)~qdWt$d^C5F* zyY?8v4dmF^Ztu3fh&k=~qQBZYej+1;=ePPAeRun=y{)wh`j&k%HQIPN5H|8SP zmxBYa+5lnGliU5u2{1GVkh+07Etcl7x2h*x(U^z@z4=Ae=`GyN_w_IhW#5H%`tpON zmD4=Gyfe%@cnOCj=2-mwL6K|%lr)u<1yKK$p#cyer~t6P63E{V00ajB@h=$wkOIN| zPgx0s^4~t706?e(0Q}!Rnt$hij@ZBBFa7TsEItGP_4f?*?+D5T{ZDUTF4%v{a(``r zAIid#l7DAqBL@=`8%J|nr~Q%juD=QxI|&U(004vRp8+DNM0yPXfUa4n0G)ucGTcVC z*7OF(wuUD3Zq|1H!~yWSasL&qO`Hsf+^nr^9J$^2i2vom{a5}+%|J}_FBd0EK4PG( z0+Fz-g9#BkJtI9MF+VI35fQJ0u_?Ebh}ggJzh`{J=1xv_+zbq^uCDa1EcCVxW(-VR zTwDx{%nZ!TbbmeQ9Nlf44BY5!97+Bo$p4KaV&Z7zU}5KEVQWM5Ph0~-TW2ReV&Z=i z{pax?>ojq*_^(Vhj{h#}Z-ET|SQwb-85#aJ%*n#^|AYNw`48-0b^S*=-hYB|t2&xE z2-{j)o7gz<|JRQ5{wve}WBjjm{s*XF;bvk56tVbAI{vMRpOf?7(El|2ub{?%fgJx2 z_}>iw4g9A7ZY2{(TPx>(Hc-{Z!ik@mm*Ia?|4$0|Ul>0VD=P!jzp?+W|DTM;|A+bS z`v1wuJ6QbPLxX>o$NztG{CC~I{dpPwx%mIB8UCZw{-yofYW%Rg4FB1-{IFizgnxUP z@>Ejfhl(4>Qs!EM_K5TEhR3e*Cov-nP;g0fy2FbB#jr>D&Lc{sau5}s+AM*$z*pdYEhu~R|w#F!2h z`Xx`aJ7lfczV&{sn&fw)oLO@HsgCY)sts)lGcb2CT0R7Tg=087VRHttJvSzpG<{q<9_&q4*`O8F(w69Nf~iTsJ}U-H}44 zaUGRHNrU9G*CJ95g6H0v8}hos;5W-@vxYr8W<;|Fi<1;HpyT&*%!(auphcGN*_%9Q zZG&T<@7fXGg+W&g$Wy_My&Km>D9Sw}fOn5K zK5KR-$9cd86~wi>dt|3O#5gUR_WPxlqsH!nwowRVR{>^I51h1O$wLqHI$@3o5An?a zT9tAK18{yYoMw;ZIE6KCJ|nd^aLX+x|8O%v{LTR?b5KLQGiM5}+_;N(W${%EU;^vp zTJG@k#gw`58=7t~I#lytA?7Z-w-4aRmKy-|nKH;b7^D4VdS?e&O9E-eE*z|Y(aG?f zJqE%YxCUvC;@kIjNs9{=HZW#2&bTXWRt~cYK2w$ai$bkhi_dlGm;?M7N596Sf4t6I zk=4zAh}#-1el!S{wcjp5kEK_ELK!BSGNHG{H>j(9y~(^6&!zHRREOvS+WqN z#AVgn&~i6r_bmj#FH;?e$Q-Pc8a?b6y>ReJjcDWBTSpDc%@G)3{%!PyzsNcntJ4nu zKteJ*t#M5n)2?HlG5eSI4fTv3y)E>0efr^P%Gtf-4liV;<7Wn`HLUwH+m#u8l|EaG zL(=S2O(<~|*U;WW+)u8_YUt;Tm!GZ5rJ;0*B8tk|7-qh-iwPwIo-b0ZI_bN+e>kVG z{Xj94Y^Nu~L?2>}a%Tq~n4Qhc7NHar6$`Dq-!HQ!#7eH}dEJxR@8weM?tbM+!oWLVHObB}xbu#nW zacF`{D8CpG`%!KBf^X?<+HMME!6-XPj!@S(SY#lM;J*Y80WJk917qmIh*slbL=(-l z88;rb(gSW;kvllOP9&Mr6npyo@HKWo@8Wbn_F6$YTOMU05ZaRG_+ydhZ(Pd|q!e%T zKlA*9t4v_`Wbomk(e+#Cy^RCWt&KR01OqVJXi=T(E2`6 z#EL{mEkM#^-2@RqKBVqL$=;kDpx2w$1H%P2X|`fN&WS|mO0ib~0w#f4Ft~duMAAaDW|yGeVE02-o!EVQFSveC#k%mn(O9EK|WBuse~n_<=rs)XRNOwp1%%?|g1z zyCFbDsPH8%P7`rO-*UkHu#zbD#Nvb$S+jzlKvouD85@K12hwpr$h&8vWyl7=t0rh2 zJv3?fX|WbSt1lnAWyek2DfR|Q1y+r3?=@()G;F;n3|Fx+zCtX&5kfwgp^WVp$&08f z!DNcM{I;Zz(ftQS(WOqmTT4z#(=k2?ZJ7C~Ik}%q_Zr8y8frBog{Z^|od>taJZd~K z@{+;)-74Vo7c&%c9rBh2Nc93vBhf_I+c3OXOmx%UFiH&s7_&)ivD^JSF`?9E?!LtC z(Qgwl@=XqiLljkn+GVN~+Sz)zXU=P#<40IHPY47Nk|uZUj&Q=-Rq#Ii`C)g+LsRVa zz@K{uW8hJ|AqOM8V3MJL(DvIpes?z{{SsB0y>A9a>kl6kju zsZ<3O+cY73qqk^xGQfvcvHzwLhLs7&fC#NaTh!go)eI-Py=yizHoQVzSn~8o+8k7q zod^&9huiNA-)hLzvtNaW%kU(bI+{6<-*;pMuQnTCF^)OxnUw{rZhJv%u*pd!!dtRO zPOC*K9IAMWnOij$H_(dau!Wb&v$`df%)l-OtL8p~ni5&r*A4mbaohuje(tlW1ib4qnDl$F5#pG5!DKSx zC#;HW(4BZj_m$3Pd+_7_k)941<`T!RQLKha#UbuhK~)Dk$=$0Y5~n*ud#_hou3ZIH zu7Nebz4#>u6Ge^-qNQ6wR#QNI|LiG2QKPW)ni<7gUri)9{dEuGrR!7akQ4P;t27i& zCn1lKd739wlmYM}^t(!$n1xtI5X2~HEJ6t83$fIT&O}M8)fo%U0BC`uqY;3soNYBOSs$YR*H23CXC==)nqWv5-#Hyq-Y0eS7)W{ z4YJWX)Trb~O|rJ`s3PDqx*4=N_GX33E5gXXUSHc`*es=4vOdZMdNJwmSk}Ta15n$! z{i(}SpQ=3AJ2wnNh}Y)h;niO+Hg;+tvCbAjFMe&N5|lo!f?2)0;st7qMhLKLfDz1Co zIy+dm6|ivy;?U4qncAL(oWAXR5sd)+Y{SvVrR>c$C*wWqqzr@)&}LCC;HPkSvs#AH zyX6MxPbj(|f10?EIMjZ(YDXn+B}AC+Hv$dHyYFMUL~Z{~Ez9|GCR>LlAJ+fLe1b-s zo3tmVPQJW1fTREUv`*jWM-4%p-vCL5qH@V{U1!7eoikFSnPl=AySICH>D2Irg7e4g zQ!9CGTdlD1jU3%fyb^mOZYs>fGoBel$aDiZr~P&FR7p`FHjnpIPR-NLBjSfVJS!4G z+$bI~wYby%gN#BAin{zm9IC9&=`YS|zB1j0ZC`w+fdT$?j_o{? zD3X#-BWpTIzXiw|zJpJ*1N&z@JAtdLVE&a;yY!$z1ia~;Bp1UHI5+SIp?d?TbweSl z84!Bm^gZe4?SmO?Rwg0;$u|9A%OKEGct?K#{X7yRUb<@T!O^!V(j;=_C^KL$Z}<7x zSz-kUq=G#g%C^BPA#KRDB_;vx{(vOiemywn@DpdVD|En_okgUAdabj|oJA2rA(=Pi zxrhf54Pfi!`}-U0HRR+`v2HN2%pV<0hM3_5J4o4I;p@!z(}nI(%$NFxbeTZ5 zb)`-^kbn%6PvdPe7RJZ{mAO_<>LlYf0VKL_b?eOE40`uyBWY>uP^N=!pndPGt3EU6KsG532H1MD80J=>$!Wf?-z92*TCOR9nPe>)=M0HZ@mgIQseLGUBu~QO`z0=m8mdhgh4RB0zTzh^W*yuY)Z|HK- zV1q2&u+_HFSZI{Dx&r?6Pzq0l-bhd&t`mn$^*OYf$EZ4j z1z3ZN(+b)$|-icf&j=gC0q{R*>Ei zd;i-D8~rYEgeMk%dgB15eV>B}c_k_$R?yBdd!0hD)45M4>uu(8yBPO8DqZqVD?RQd zvIuNJbf$2O5d_}J2z)sWlVW<1?R`A4v~QOy0eaCTdkdeWUhG)6?!QzjV@m{8qCE}WDv*g&zNbxJMuI)!LEc*hiwirAPBalY+ zYG&+Tfs7%z{O-d<23r{j4r?O*^gnb|t092bzfva^oa4;BDSP=Kxmn=AJo(2p%Tche zML*F87aiV^*S{OY(I8P6Ps7vv^m}+4S3AF+7a!yfH#DkliLrp2_dJ5L)G62qxXc}u zySaJaGonTF;}mkqLbR|P5e(r(m0O7L>>LK#60Fajx~JG$VB%dGndkDz#Pgd}Z;6zb zF@h_Gy3A_@O|Rjx1>)?bCbAxJRtK4st^R$Ssf|#JpWA0G=v{vjG-Fn>N9Ddjtj08U zHSF8~qXx_~kg9*Wt189Q{$$Z zGK3^!a_je4$ol~r%90;fVmz&z3P-N2aTMYSUF3PDfC7zeEJ1=8p;fJ!*#pLRZr?p5 zDEM%knXx=kRHu!=SR%97%6peemK#F>Ww(n$68ed7biJ`}dOv!5ty%poW$TI#hZ8Be z*WwKkuOfRk`eCz%Jn;Hkto)k&LGO`0w~n?wjhTK_;GVl_TXu~2-kx7AuB9FYOrr4p z62J(TK#sUc%X!%{-lG}oXWuJF|wf1Nw}_LDuW$9a9(Z{p?Baf)*9GK6}m0(Ddc zJ)PFH{yEib1WZLqj~aeBv?F02YFC-~B2bx_9^PBc7)m}10D%l|c1$E)#VTy( zNG!7^MDkVBlyxmnc9O@2=-M(0C!7phi-*l$4y90Ca-i80XdCcl#R%i;zK->Ik^Jh}oiAvVeLT-YnH$-pWm?05Hx z9M7fv4v6$4aIaIRC6JMTnXC%2_eZ^{*LeZ#-!IUJ=?a)QRlVNRFYJcFfzpb8W`;qGM2G7q;lq|# zYgHl_+-M#+nXxN{WHFa(Sf?By;;SxKlJas1OzZ8UBlq9;Xivc0s0X1tuzxiN9ZzR)U|UPNJz7|nCX3!9SSB6s;I z)6ubnijuM-`o?LS3xhZ06H?gzx|aVPH?As9N4;v0lz&9!J0|Q~XM{-O|Zn zNVsB?+UR>(;;ac>3jcL73;oIVD#fg!0`Er+sm^-aI1dn+wwj+sm4EEH>%aMsVuB=O z<4tMP!ld1)sf+PXser-2UzK)13%x!BB8~{P0P_8z94{EC#v<&Z{k7?&n8{(<;PD6> zs$oagmtnz54O?M$eoLrg>}@>R#ODu&SE+-bQdim2O<@6%cZW@CE1E8)L8bp- zk%~l+xB>Eu2wtg4_AcZR5J7KWNP&dL`+36V#@OBDJX%cnrFk?%xBMKs?t`qLloi}< zADmxMqqqX~2ovEFnaDmRu7&26a63kfMoX|py}bl0jyqj@gy(}>1xNJMnq+;+dD}8N zYz|wb%=d}r&1jsW;EH3GOSy~3noR=a=nX(|t>|!Lh_;(xjqv{%r9AtP!H+f>!|$Rw z!A*%jDJBpwk}lhL+466IgW^%BP^OJ=NsefADsh8>W3|=i0!uVI*${As+>GL3;a{6`CNBe$5mAsQxcNubAlYpsVR1?Gs$aR(ItYH!) zc@%i|&bp&g`RVv$S`dH#c>g4*OoT1j%$Xh|-x{+xioec`J&h#jyQcYT|c)2ltKgt&q+g}xHN1=Ac!G|$uLGB*BstBSUbuM?4RPfex`EfWYLEM zeuS*N2OXH&!b`CD(32k;^QOPV!J& zn&C%at3{l!J=ihhtZB=1bag>AG)l7*Y-`&bt9`#YN?)xxOW%%#EFS)lH88=3mlMM> z%K0cE$i|?XTf7d<``Rs;#lx}Y)|w#zr7_M3Eu|)0ZST;`j^elos(ue{Cmhbb22M%aF-#6I1J#(GTf;CSlU43pDD@bFBgr_CmGRYPW z3aD#c-?|^$#-X)szYESyVF9n88=K_Pkt273lXR3vc*uPmH;$MJM;0*_YviHDhiv*R z%j3W%1z)QN}xeUTpC()er6z9hJp z)f93~B7F9MQt2~YI&t9dgA}nuZsEm2#5h`PE;L><>&Kcn*|)<94Y#2;>-=`L1U_r6~RicxJ+T0DqE7nT;r9G61T9q|7c=}?g9L^_I{MOzd( z?%~V|4z*%*+&C@nMgI8sO+KC2=a7T@=SpdAhXO1m+dP5l?d0$O6*2PAFJ-nFKVG&z zl%5~>zqNHr=uYM0X)kQ7|FE{YK2uaHjD$B&%(gJ0xmp2awnEcQ?{_>>xYpMRT$(di zb5xnXDn&ADPBgsR)aE%Y%#kgp_+>5|SyqQCz@Hrg-|6)~ZCZuM*f&-61h|tR90JqfnN<)lsy5QD)F|%Y z9U42RIk3XmEDT@FK{f`dV5td>(v**(5nV-J{EUAQHPzjdVn)doZ+F_$6+x9kxjldt zKcz}#7PCFiF-c$$q6Hyjbu|YTIJRy7U>;S#jNu|E;Znu1V}vnWoi6n6NCP=Jg74tp zF^SEfZGe|R=zP-6IuHrEb~o&E0#u}}ar(W;QJ5Xz$Eli8^m|B~trNU{t# zF~ekmm=AWmLzKPGvUDMA=-IOalP;9Bp z`>8B#CewRtdNpX!f~=Cxt{OLl5pA0k3hX9nnsxdMD7|CjJl+{`-W%iLUm-@8X;iB= zU+Cu%ZU;#3D&ueQkMH(bt2r!NAj}Y{ibmuj;}lZf4T5tw5wp;za0tZl2m6=Me+*cH zc-d>+j#=ROiWMb*_`w1YMjO%rwh2hzfUapRcR`u7F&){(=xu@TWY{e!2|g-VuCNG| zy3%II=CNKL0q6*`=^>M^)#RfGDXXf1O?U2r2M*;X{@Gc6!C9-K=$(P*%%silKUr`I z0O>oZ92McEl4}cMT1Xq;-yc@((#+#rY?&BkOZCkX062CP*JW26rN>)5v{ZwFppJX) zGOX)j=7_sWivh>dP)w$~9a9amk}OB=<`RtzDXUS13}dql40gHWvm$@IyH<)^eR)sr zogz}HHqOzgn0B0fuw1ML11H6v(ZgSz#Uv-Z+3`X`yA(OGPlPm7=otD#tsq%0PNv;l zr9NXGrmh((-MMf%WeBj!4OmOSDV6bZ7d)d*-)1=AHl?>y$QQRh!I33vtn8UhUXa@_ zez?7BP`tmyl*Vt6daNo6tUIc+C2Q-;<4=THBAA7|VmAHwOxFn-Wi7<{SU}#aH4LXx zb`L}Se&|2OaUyb^(yBYr2S1o38p&#Ix41u3^jv6yO?nDl;Wa&flNxx`alM%Kr_IE4 zoG^j)`BQH+n_=S|fyc)sRG1R9@3bh~JW@Kjbz*jMOuXMCxLQ5b zRJ+ftcEqMZY1Ka*i;~w8=VoGoV3Ra%glBm^y}gw=s2WCm!DxTwLR~dKYBlWx<4dM# zxR4VzwHoZcY|1fD<&IIk);hLLZki+(mplPW46$;z0-Cw)wd7gZD+g8_KaOoQLTj(^ zLdlS`C)3M9-@*zLxApyUux|16na64L15Ss#M~+PMPX&mD=;cEw<@_K41`b?H*U98S z&%uR2AF3};P3Ybw>1JOf2e5XbPUHSI^upq#KB0bGa0fUrfyS5`vZ*l>qPIg6cV>c~ z8nV?srjK@Hz>o_1bRdg1lhZrTg%d1Jm=nzK>4vc$Y9-mK2t)XJr|I@|wb_hJ_>|?l z4ZYi_R>cLwal~RmjW9+d~VN+7|&dRFzxmco4?{Xr58l+(C%e@^7H9kGfsJQat-(AR2? z8u(eC*4`uEQWu2tl#UVB@sft^&_U%#9LQ~2@&+O;iS#v#==&-#vUjhKW#g@Yl+iL8 zxM@No%;Ih6b>8%Mo%;5R5!THWU6(YD90mTt8q`}USA50m5)^(9For6)erLzbbtmk+ zTl$|B#OI}6A7m9B^3P2(-;+0kFuy=*E;iL&d4L?Jom7KaFv$}6MUway>P-*IpdlkO zK$Gvbvj#Bc33eX%u;B&_$I|eIC{rW_JoO9-<;kEdg%OD?pQ0sOlbzL z5Pb6VjCv!DL8l74Y}{G=Kvu$SfMPDfX)lQdCLuB!gZ@~?%sXEIJ4(-617}K`bdZ#_ijCyGmi1S zt(~gipB23xTda-E<3L-sL>L4#7OCuuyBZo>a68Sk>vg)w9A~j=kqj#OgdNL#H09W- zV{*X)oLFfw%z+NS<$xXAILQh|g?0bsj{v~~!Boz0 z(bN3 zS@0=)n;N;t3J{)^CfF!)iNj1RET|(x_3Emh##rAk`zWny>V8f+;*?^ekI=8NO#Ft_ zOqFO5j6N(!{i=&?ysV%Hay^OxJbTjb%JU(30Q14or}??UAFyG+_iYw)k@_bw(v>b< z7$*n#4PB#F@@DfFaP6(4%UUb1d|>eNR6CDJ=!Y-vX%sMS$7zRh)-E8T#$I(8cWchhR9QFk-Ef5#on0U9QH@}7`V;V; zmk$M@FrbRJ0PF13)F56ECbS?ptp|>Fs0v4FJk65Dy1o6`eol$G{6tzP7;m*M_6dp&Mjk6fBVwadC=OcO7zkFC^I7R|ye+0-X2pf2o19 zP(t!876m3Izgj_Xx*_88kv|$I{*=YTo~eveVK4$;GZAsqA*|;434a^_NX)yN1 zs}f2wm34#6&j*$F6N$;W6lqw_^i6>I@qr2+WeZfTYis5;;}57-Kc(E3(8}t+!o!Wa+~7FxwWHMDSn2yhdmqrmxuWoq`0KWEf-DN0fw1TOL%c=b-{}=sV%5gVY>k|ap74cQ0JZQYl02WE*0R!O z7!jWEkKe`BudODkY&Za~k)=uoUNF^f>byIg%zSMcTylpUDvgeV1OxM&I1+>1koQHR z149sIp`<<9J=a)+D|QR#d}&#jL+QUpDc@quD@WGvlBGwzuhno%sZg#WHz#&r!G&kS^=2 zg4ym=<}*qE-bgyvDpeH@7^|CS=R|Ax4o5NJ^qz^J)g`Hay+{J&hFR-$q8{@}0Si@b z(7u=nCz!_|1lSmkt(_EK?}iR8zuvLXu%!@8zU&bJ%HnB1IaqcUzIV(r!lQ9)-Dv&aJe z^gJ;dMDAOvcMXX;z;T_JqpyBzlTbgtPa^pEyb|Ds^8F(B z`9LhFfe}o8k-SLU?agUupFK&>5U|f`V~6fl-u@`_FA_Xd6h&CH*VMhb;esit@auBZ zM2D?jrp7O&Og#l!Gxrn~fOHnG>1ZnjC@`x} z5tsiu>VN5msl2oYZckJo&6F$YTx9gKJUXFv4~AqGxh?{eel@}t81XF{N1`Ev zVE2%X>A?r{X<%zha``YO{0R3;whYIBYk|!dM7P)EW;*T7FUkhPigAO7=(lA73IEXYeiL=5g-(5*3sCkuRP7eE zb20=iHPKU5tLggV#p{CpL(lW(fx@Q_BU4jQFTxH1{E^G4_nv>=-<1@V6R8%`5BNV+ CUNY?f literal 0 HcmV?d00001 diff --git a/docs/cluster/README.md b/docs/cluster/README.md new file mode 120000 index 00000000..84733930 --- /dev/null +++ b/docs/cluster/README.md @@ -0,0 +1 @@ +../../mindtrace/cluster/README.md \ No newline at end of file diff --git a/docs/core/README.md b/docs/core/README.md new file mode 120000 index 00000000..cf4f9da3 --- /dev/null +++ b/docs/core/README.md @@ -0,0 +1 @@ +../../mindtrace/core/README.md \ No newline at end of file diff --git a/docs/database/README.md b/docs/database/README.md new file mode 120000 index 00000000..2640a987 --- /dev/null +++ b/docs/database/README.md @@ -0,0 +1 @@ +../../mindtrace/database/README.md \ No newline at end of file diff --git a/docs/hardware/README.md b/docs/hardware/README.md new file mode 120000 index 00000000..dc749e48 --- /dev/null +++ b/docs/hardware/README.md @@ -0,0 +1 @@ +../../mindtrace/hardware/README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..9354cec4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,31 @@ +# Welcome to Mindtrace + +Explore the Mindtrace Docs, a comprehensive guide to streamline both hardware and software integration, as well as machine learning workflows within your organization. Whether your team is deploying complex infrastructure or experimenting with new models, this hub is designed to help companies unlock the full potential of Mindtrace across their projects. + + +## 🚀 Quick Start + +### Installation + +```bash +# Install the full Mindtrace package +uv add mindtrace + +# Or install a minimal dependency chain +uv add mindtrace-datalake +``` + +### Basic Usage + +```python +from mindtrace import core, registry, database, services +``` + +## 📚 Documentation + +Explore the documentation to learn more about each module and how to use Mindtrace in your ML projects. + +## 🔗 Links + +- [GitHub Repository](https://github.com/Mindtrace/mindtrace) +- [PyPI Package](https://pypi.org/project/mindtrace/) diff --git a/docs/jobs/README.md b/docs/jobs/README.md new file mode 120000 index 00000000..e028feae --- /dev/null +++ b/docs/jobs/README.md @@ -0,0 +1 @@ +../../mindtrace/jobs/README.md \ No newline at end of file diff --git a/docs/services/README.md b/docs/services/README.md new file mode 120000 index 00000000..7fa70e5e --- /dev/null +++ b/docs/services/README.md @@ -0,0 +1 @@ +../../mindtrace/services/README.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..4717a9ae --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,72 @@ +site_name: Mindtrace Package Docs +site_url: https://mindtrace.ai +repo_url: https://github.com/Mindtrace/mindtrace +nav: + - Home: index.md + - Mindtrace: + - Core: core/README.md + - Jobs: jobs/README.md + - Database: database/README.md + - Services: services/README.md + - Hardware: hardware/README.md + - Cluster: cluster/README.md + +theme: + name: material + font: + text: Inter + code: JetBrains Mono + logo: assets/logo.png + favicon: assets/favicon.ico + features: + - navigation.tabs + - navigation.footer + - navigation.top + - navigation.sections + icon: + repo: fontawesome/brands/github + palette: + # Dark Mode + - scheme: slate + toggle: + icon: material/weather-sunny + name: Dark mode + primary: deep purple + accent: green + + # Light Mode + - scheme: default + toggle: + icon: material/weather-night + name: Light mode + primary: deep purple + accent: deep orange + +markdown_extensions: + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - admonition + - pymdownx.details + +extra: + social: + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/mindtrace-ai + generator: false + +copyright: Copyright © 2025 Mindtrace From 80a0c3702818c16da1ff2ec7294656a2242daac4 Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 08:59:35 +0100 Subject: [PATCH 02/13] add read me --- docs/cluster/api.md | 6 ++++++ docs/core/api.md | 6 ++++++ docs/database/api.md | 6 ++++++ docs/hardware/api.md | 6 ++++++ docs/index.md | 24 +++++++++++++++--------- docs/jobs/api.md | 6 ++++++ docs/services/api.md | 6 ++++++ docs/storage/README.md | 1 + docs/storage/api.md | 6 ++++++ mindtrace/core/README.md | 5 ++--- mindtrace/services/README.md | 14 +++++++------- 11 files changed, 67 insertions(+), 19 deletions(-) create mode 100644 docs/cluster/api.md create mode 100644 docs/core/api.md create mode 100644 docs/database/api.md create mode 100644 docs/hardware/api.md create mode 100644 docs/jobs/api.md create mode 100644 docs/services/api.md create mode 120000 docs/storage/README.md create mode 100644 docs/storage/api.md diff --git a/docs/cluster/api.md b/docs/cluster/api.md new file mode 100644 index 00000000..2580e105 --- /dev/null +++ b/docs/cluster/api.md @@ -0,0 +1,6 @@ +# Cluster Package API Reference +::: mindtrace.cluster + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/core/api.md b/docs/core/api.md new file mode 100644 index 00000000..d5a9e054 --- /dev/null +++ b/docs/core/api.md @@ -0,0 +1,6 @@ +# Core Package API Reference +::: mindtrace.core + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/database/api.md b/docs/database/api.md new file mode 100644 index 00000000..2d56b266 --- /dev/null +++ b/docs/database/api.md @@ -0,0 +1,6 @@ +# Database Package API Reference +::: mindtrace.database + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/hardware/api.md b/docs/hardware/api.md new file mode 100644 index 00000000..131bb081 --- /dev/null +++ b/docs/hardware/api.md @@ -0,0 +1,6 @@ +# Hardware Package API Reference +::: mindtrace.hardware + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 9354cec4..81cec07a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,21 @@ -# Welcome to Mindtrace +# :material-rocket-launch: Welcome to Mindtrace Explore the Mindtrace Docs, a comprehensive guide to streamline both hardware and software integration, as well as machine learning workflows within your organization. Whether your team is deploying complex infrastructure or experimenting with new models, this hub is designed to help companies unlock the full potential of Mindtrace across their projects. +## :material-star: Features -## 🚀 Quick Start +- :fontawesome-solid-microchip: **Hardware Integration** - Seamless hardware connectivity +- :material-brain: **Machine Learning** - Advanced ML workflows +- :material-cog: **Configuration** - Flexible configuration management -### Installation +## :material-link: Quick Links + +- :material-github: [GitHub Repository](https://github.com/Mindtrace/mindtrace) +- :material-package: [PyPI Package](https://pypi.org/project/mindtrace/) + +## :material-rocket-launch: Quick Start + +### :material-download: Installation ```bash # Install the full Mindtrace package @@ -15,17 +25,13 @@ uv add mindtrace uv add mindtrace-datalake ``` -### Basic Usage +### :material-code-tags: Basic Usage ```python from mindtrace import core, registry, database, services ``` -## 📚 Documentation -Explore the documentation to learn more about each module and how to use Mindtrace in your ML projects. -## 🔗 Links -- [GitHub Repository](https://github.com/Mindtrace/mindtrace) -- [PyPI Package](https://pypi.org/project/mindtrace/) + diff --git a/docs/jobs/api.md b/docs/jobs/api.md new file mode 100644 index 00000000..6cbff20d --- /dev/null +++ b/docs/jobs/api.md @@ -0,0 +1,6 @@ +# Jobs Package API Reference +::: mindtrace.jobs + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/services/api.md b/docs/services/api.md new file mode 100644 index 00000000..4c49255c --- /dev/null +++ b/docs/services/api.md @@ -0,0 +1,6 @@ +# Services Package API Reference +::: mindtrace.services + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/docs/storage/README.md b/docs/storage/README.md new file mode 120000 index 00000000..264e14ca --- /dev/null +++ b/docs/storage/README.md @@ -0,0 +1 @@ +../../mindtrace/storage/README.md \ No newline at end of file diff --git a/docs/storage/api.md b/docs/storage/api.md new file mode 100644 index 00000000..4ebcbed0 --- /dev/null +++ b/docs/storage/api.md @@ -0,0 +1,6 @@ +# Storage Package API Reference +::: mindtrace.storage + options: + show_root_heading: false + show_source: false + heading_level: 4 \ No newline at end of file diff --git a/mindtrace/core/README.md b/mindtrace/core/README.md index 154996ed..b2d8e8c0 100644 --- a/mindtrace/core/README.md +++ b/mindtrace/core/README.md @@ -50,7 +50,7 @@ The core module is organized into several submodules: ### Logging (`logging/`) - Structured logging configuration and utilities -## API Reference + ### Core Classes @@ -78,7 +78,7 @@ print(config["MINDTRACE_DIR_PATHS"]["TEMP"]) print(config.MINDTRACE_DIR_PATHS.TEMP) ``` -For detailed usage of the Config class—including how it’s used within the Mindtrace class—refer to the [Usage documentation](../../samples/core/config/README.md) +For detailed usage of the Config class—including how it's used within the Mindtrace class—refer to the [Usage documentation](https://github.com/Mindtrace/mindtrace/tree/dev/samples/core/config) ### Observables @@ -228,4 +228,3 @@ Dynamically instantiate a class from string reference. from mindtrace.core import instantiate_target instance = instantiate_target("my.module.MyClass", param="value") ``` - diff --git a/mindtrace/services/README.md b/mindtrace/services/README.md index 76994b3c..12d37576 100644 --- a/mindtrace/services/README.md +++ b/mindtrace/services/README.md @@ -9,7 +9,7 @@ [Architecture](#architecture)
[Auto-generation for Connection Managers](#auto-generation-for-connection-managers)
[Usage Example](#usage-example)
-[Testing & Coverage](#testing--coverage)
+[Testing & Coverage](#testing-and-coverage)
[API Reference](#api-reference)
[MCP Integration: Exposing Service Endpoints as Tools](#mcp-integration-exposing-service-endpoints-as-tools)
[Remote MCP Server Usage with Cursor](#remote-mcp-server-usage-with-cursor) @@ -69,7 +69,7 @@ cm.status() # now generated as a method ## Usage Example -See [`mindtrace/services/sample/echo_service.py`](./mindtrace/services/sample/echo_service.py) for a full example. Basic usage: +See [`mindtrace/services/sample/echo_service.py`](https://github.com/Mindtrace/mindtrace/blob/dev/mindtrace/services/sample/echo_service.py) for a full example. Basic usage: ```python from mindtrace.services import Service @@ -115,7 +115,7 @@ class EchoService(Service): return EchoOutput(echoed=payload.message) ``` -## Testing & Coverage +## Testing and Coverage The test runner supports unit, integration, and stress tests: @@ -181,7 +181,7 @@ The Model Context Protocol (MCP) is a protocol for exposing service functionalit This makes the `echo` function available both as a REST endpoint and as an MCP tool. ### Example: EchoService with MCP -See [`mindtrace/services/sample/echo_mcp.py`](./mindtrace/services/sample/echo_mcp.py): +See [`mindtrace/services/sample/echo_mcp.py`](https://github.com/Mindtrace/mindtrace/blob/dev/mindtrace/services/sample/echo_mcp.py): ```python from mindtrace.services.sample.echo_mcp import EchoService @@ -286,9 +286,9 @@ asyncio.run(main()) - The MCP client allows you to list and call tools programmatically. For trial purposes, see the sample files: -- [`mindtrace/services/sample/echo_mcp.py`](./mindtrace/services/sample/echo_mcp.py) -- [`samples/services/echo_mcp_service.py`](../../samples/services/echo_mcp_service.py) -- [`samples/services/mcp/mcp_client.py`](../../samples/services/mcp/mcp_client.py) +- [`mindtrace/services/sample/echo_mcp.py`](https://github.com/Mindtrace/mindtrace/blob/dev/mindtrace/services/sample/echo_mcp.py) +- [`samples/services/echo_mcp_service.py`](https://github.com/Mindtrace/mindtrace/blob/dev/samples/services/echo_mcp_service.py) +- [`samples/services/mcp/mcp_client.py`](https://github.com/Mindtrace/mindtrace/blob/dev/samples/services/mcp/mcp_client.py) ## Remote MCP Server Usage with Cursor From 5366aa500b20fb719b6f589d2b263757f0cdb974 Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:00:15 +0100 Subject: [PATCH 03/13] index update --- mkdocs.yml | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4717a9ae..497aa1c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,16 +1,58 @@ site_name: Mindtrace Package Docs +docs_dir: docs site_url: https://mindtrace.ai repo_url: https://github.com/Mindtrace/mindtrace nav: - Home: index.md - Mindtrace: - Core: core/README.md - - Jobs: jobs/README.md - - Database: database/README.md - Services: services/README.md - Hardware: hardware/README.md - Cluster: cluster/README.md + - Jobs: jobs/README.md + - Database: database/README.md + - Storage: storage/README.md + + + - API Reference: + - Core: core/api.md + - Services: services/api.md + - Hardware: hardware/api.md + - Cluster: cluster/api.md + - Jobs: jobs/api.md + - Database: database/api.md + - Storage: storage/api.md +plugins: + - search + - mkdocstrings: + handlers: + python: + options: + docstring_style: google + show_source: true + show_root_heading: true + show_root_toc_entry: true + show_signature_annotations: true + show_signature_return_annotation: true + show_bases: true + show_submodules: true + merge_init_into_class: true + show_if_no_docstring: false + show_signature: true + separate_signature: true + line_length: 80 + max_depth: 3 + filters: ["!^_"] + members_order: source + docstring_section_style: table + show_docstring_attributes: true + show_docstring_examples: true + show_docstring_parameters: true + show_docstring_raises: true + show_docstring_returns: true + show_docstring_summary: true + theme: name: material font: @@ -22,7 +64,13 @@ theme: - navigation.tabs - navigation.footer - navigation.top - - navigation.sections + - navigation.expand + - navigation.tabs.sticky + - search.suggest + - search.highlight + - search.share + + # - navigation.sections icon: repo: fontawesome/brands/github palette: From 0dd0c8df3ba49af5c1467d480f3182db0b8d99e0 Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:11:37 +0100 Subject: [PATCH 04/13] add mkdocs dependency --- pyproject.toml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 9e3e1330..29d2cad1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,8 +33,8 @@ cameras-basler = ["mindtrace-hardware[cameras-basler]"] cameras-all = ["mindtrace-hardware[cameras-all]"] hardware-all = ["mindtrace-hardware[hardware-all]"] -[tool.uv] -dev-dependencies = [ +[dependency-groups] +dev = [ "pytest-cov>=6.1.1", "pytest-asyncio>=1.0.0", "pytest>=8.3.5", @@ -42,6 +42,10 @@ dev-dependencies = [ "pre-commit>=4.2.0", "twine>=6.1.0", ] +docs = [ + "mkdocs-material>=9.6.21", + "mkdocstrings[python]>=0.30.1", +] [project.urls] Homepage = "https://mindtrace.ai" From e14e470387e3e7f691eb9dc13030849d8489370e Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:55:18 +0100 Subject: [PATCH 05/13] format --- mkdocs.yml | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 497aa1c0..8dcf9c18 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,14 @@ site_name: Mindtrace Package Docs -docs_dir: docs site_url: https://mindtrace.ai repo_url: https://github.com/Mindtrace/mindtrace + +extra: + social: + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/mindtrace-ai + generator: false + + nav: - Home: index.md - Mindtrace: @@ -58,6 +65,8 @@ theme: font: text: Inter code: JetBrains Mono + icon: + repo: fontawesome/brands/github logo: assets/logo.png favicon: assets/favicon.ico features: @@ -71,8 +80,7 @@ theme: - search.share # - navigation.sections - icon: - repo: fontawesome/brands/github + palette: # Dark Mode - scheme: slate @@ -111,10 +119,6 @@ markdown_extensions: - admonition - pymdownx.details -extra: - social: - - icon: fontawesome/brands/linkedin - link: https://www.linkedin.com/company/mindtrace-ai - generator: false + copyright: Copyright © 2025 Mindtrace From b3d46b4277fba2a04bc718b123828d9c49c64af5 Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:55:25 +0100 Subject: [PATCH 06/13] add mike --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 29d2cad1..e679e616 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,6 +45,10 @@ dev = [ docs = [ "mkdocs-material>=9.6.21", "mkdocstrings[python]>=0.30.1", + "mike>=2.0.0", + "mkdocs-git-committers-plugin-2>=2.4.1", + "mkdocs-git-revision-date-localized-plugin>=1.2.4", + "mkdocs-jupyter>=0.24.3", ] [project.urls] From 2dfa8a8290e638dbb8c20b723aef0f715ebf1b7b Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:55:49 +0100 Subject: [PATCH 07/13] add docs workflow --- .github/workflows/docs.yml | 71 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..56420e52 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,71 @@ +name: Build and Publish Docs + +on: + push: + branches: + - dev + - main + - feature/documentation + workflow_dispatch: + release: + types: [published] + + +concurrency: + group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}} + cancel-in-progress: true + +permissions: + contents: write + pages: write + pull-requests: write + +jobs: + deploy: + name: Publish Docs + runs-on: ubuntu-latest + timeout-minutes: 10 + strategy: + matrix: + python-version: ["3.11"] + steps: + - name: Checkout the repository + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + fetch-depth: 0 + + - name: Install uv and set Python ${{ matrix.python-version }} + uses: astral-sh/setup-uv@e92bafb6253dcd438e0484186d7669ea7a8ca1cc # v6.4.3 + with: + python-version: ${{ matrix.python-version }} + activate-environment: true + + - name: Install dependencies + run: | + uv sync --group docs + + - name: Configure git for github-actions + run: | + git config --global user.name "github-actions[bot]" + git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com" + + - name: Deploy Development Docs + if: (github.event_name == 'push' && github.ref == 'refs/heads/dev') || github.event_name == 'workflow_dispatch' + run: | + uv run mike deploy --push dev + + - name: Deploy Feature Docs + if: github.event_name == 'push' && github.ref == 'refs/heads/feature/documentation' + run: | + uv run mike deploy --push feature-docs + + - name: Deploy Release Docs + if: github.event_name == 'release' && github.event.action == 'published' + run: | + latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`) + uv run mike deploy --push --update-aliases $latest_tag latest + + - name: Deploy Main Docs + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + run: | + uv run mike deploy --push main From e2a231c53a676409fda980820804c14edc6ad57a Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 09:59:20 +0100 Subject: [PATCH 08/13] test on branch --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 56420e52..b7f6ffd7 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,7 +5,7 @@ on: branches: - dev - main - - feature/documentation + - feature/docmentation workflow_dispatch: release: types: [published] @@ -55,7 +55,7 @@ jobs: uv run mike deploy --push dev - name: Deploy Feature Docs - if: github.event_name == 'push' && github.ref == 'refs/heads/feature/documentation' + if: github.event_name == 'push' && github.ref == 'refs/heads/feature/docmentation' run: | uv run mike deploy --push feature-docs From f395d09e2be423637951142c8e6978214247e70e Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 10:00:40 +0100 Subject: [PATCH 09/13] fix python version --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b7f6ffd7..bb1fb79f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -27,7 +27,7 @@ jobs: timeout-minutes: 10 strategy: matrix: - python-version: ["3.11"] + python-version: ["3.12"] steps: - name: Checkout the repository uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 From 6dd7879c9f48142bbcbd27ea5497e1715dfb9fa3 Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 14 Oct 2025 12:10:50 +0100 Subject: [PATCH 10/13] make dev as default --- .github/workflows/docs.yml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bb1fb79f..5c5286b8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -10,7 +10,6 @@ on: release: types: [published] - concurrency: group: ${{ github.workflow }}-${{ github.event_name == 'push' && github.ref}} cancel-in-progress: true @@ -54,6 +53,11 @@ jobs: run: | uv run mike deploy --push dev + - name: Set Default to Dev + if: (github.event_name == 'push' && github.ref == 'refs/heads/dev') || github.event_name == 'workflow_dispatch' + run: | + uv run mike set-default dev --push + - name: Deploy Feature Docs if: github.event_name == 'push' && github.ref == 'refs/heads/feature/docmentation' run: | @@ -68,4 +72,4 @@ jobs: - name: Deploy Main Docs if: github.event_name == 'push' && github.ref == 'refs/heads/main' run: | - uv run mike deploy --push main + uv run mike deploy --push main \ No newline at end of file From 14b331cdc3905fa2c2edaae35cf510da98758e4f Mon Sep 17 00:00:00 2001 From: pankhuri-mt Date: Tue, 11 Nov 2025 13:10:25 +0000 Subject: [PATCH 11/13] add favicon --- docs/assets/favicon.ico | Bin 0 -> 15406 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/assets/favicon.ico diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..791c01e1eae51bc74f1d4542d1fb964b62c248bc GIT binary patch literal 15406 zcmeI3d8}UdS?4bu5b7YHBNervp)&tej0Q#(1w?_FL}i^)jWQsj4x$UCl+w^rrcr4X zNCSkXr40#bNYkW=8)pyM9LG*sVzVG+F_uaR%Z}0ui=Q;0v9oxM(cG6}3 zfRh}b^PcVZ?ECHO`@X*a(D$Y{^>N(R_p$Hq>-)vNzP@eSy1#$=KlSz9%e8mBW8?nY z`}&UkSYO{y^9-->M)x|0O*d_}t*=Yx_Kw!Gl&84HzRvaY_sw2^<=u5W-<6D2HJeMd7no61_MXSpS7Z&6XPAD$5xpyH9=icA=c9wZcTSH2!?3Fns zwKc`_Qwk@h{!_rOh$kWz9wV&WfUPQT~x(HIDI( z?0h^r$~u99a7IDEI?aQ;e@u}xs<<}HH%65@6$Qgbl+;^thF8={GhpcCcsukMQx=CxYYoK<%UtiS@21mgC1+J^Js>Zhk{1lBRoo8zXO(&j zywikcbtUb2x%;o@SX37I>U6s6*Lk;@Oldy2OKosyc}Elmqe`MBDNEFxxkf?bkg_aL zS{;>t=thO79?f}R@UO-Pv>fhJH9iS0o|dYAr!=i;zVJ!4+ApwHOQAC)fA$9GmMU}W z`JU4cvCNQ_B#lk=j=)eND1R+Jlz^Zp5W(X2vuRKd&*3g^BE4^HK{n+)U|$Bca? zeq0ODy?kf4CfnD6U#z*6KhKEnQiP>vYUO{YTI=2%`SEc&?Cf! z#|;~lBelu7(QT`Jv!yn@w#EAE8M2PPWJ#<}9P_HljxozP-#y=IZM%Ni+ZOA0Sl8^Z z+0v*|K_^0%2BzK)9N*3LvmjKA4NqNH;YvZ?^ei^L-G#&a18`iPZQq(lJ@}2Lz4P@9 zJX2`yJLqjy;nD&&wFV7pawo7=V-t$jDoVoy5H9`gbKl)kR#J2>0tD7f9K{W6z3;K! zBz6zl7g&FJPSLFSg+&GUBzN~Q1w;6#xhk?@a>D;xe*e{BG@ER8J&PMkO8f8~L-?{4 zj#K!fB7Owhy)+|#@59_LDx98Iv|N+7Z$yoMJ&uoZUi11L_}Al|*^JbmV=a7OYglPx zT=B|2)-5ZV8vy4KY)PuLjc+ckf&0HIt~>bFlKio?+_zpH{#`r`-!z4{Nlj@|myh2{ z8ZRoYvSu5<*%)M>#Fx3i0RGKYMboF1l$Vux$l~m{!o?Li_w81+P=;SV@Zg&+@Xwpk zylWrLZ^toyy?qKFF($9^veIY<`WK<=eTvHm@Vj*dQxC8cge zS$y_o=u=c-`$4VT!@c-hV~mSsBI^(vMZ^{1vf^-2NnBQzHjwe#k)Du6RU z;}IyYtUf94>Gvrbdjwf`@C$YB5wph@r$%|aZ*(^~>BX7d^*h9hC$tjm$a%in_?lLm zcPfP^7W*c|edgEFu%OoJop}suv=7RAkpI#ATlUTMEK=59WZeROVN~uuV#?Wl(89~( z!E7DA17~jAz^%6>9Y@7zC-gr|tl3u0dmjEj%6SVozOK3Qr_q1pyxp(G!Cz8+`No_c z#_x5LC9})T5p{wR`hg5!FQd{4HMjq|oV}mHN31|6?9&=DW6!g8FU~g@Lhu_7zCf(} z7`%5?0ghsX4g=SG?Qb=-{2q9?My$D}wbJ!+TDy<|^RE$mM}GN!tsQ-f+=ai#ZXy3% z%ivWs{RpzKAG>%)&D(!L-c#2rYZW)_dYAu@Bd13_MZS_z=NW%%9l*N|ECGsS*(6hRm0PF$2$hSj>~m*qV0A!XHt zoa|=DiR)WgH!OD_>Rf#kUayTn`P%HP@cNHkpkuox9NgbQuBcMyGY`1UMwX zl3+WWWJwY7XBv}ouN5CtD?F0hrVN}?=pF*dBn8XW#f4UWE5wI((P*fZ#y!p|gJkURLl)!g$2Ift*nZx;AI+J7Dlz4d!X zgM!!9&gON}zgkD!|Dkg7vSRGeZ1^Rebv~eCu!rxM-X|(Mk7#K6=QKL|tLWqbh29wZ z1h^6}C7!(bFQ|3um*p?rhQ8nzY=KwVdh5r?d^N=$#!sl-S%A0526?0tPpjs?3=BJw z6SIpIwVV6pwU4OP+@s0)_iA$Cy>gs>WN#fBP$wZ?N}#>rbvf&sRj_9*_sx(Q+Y@Bo zXjcjM>u~*7bfEmR{+K4ngHvpE2fyU{XEZqf^ExvAMxC7gDV3Y| zz@M&;<$4AVT-f;XtF8Vj_kbfvR<(>C&bVJjA5H@siqCb6ze-K6uYN?O#$C|6@+u#C zowr!W!lW$0j}jO3>Kt7HK_Bd55E1vJtsJJ;xyq}*W-!=p+xh3`ejA}a4&y@(qT~>M5O=*zSBB?EJjn=fiiY^R2+T?CY0+ z-(WYm4Zg&26i^FF9c;7J_K7JBFAP+7-@v2GqYLAKt?;;PIJbK6Qt+FAca(H_k*yZ&u&mx7^P0dhar)Sf0@|UYujDQe2&^ckt?9exSff-enfA`@jf z&kd62k#DTgL$!eYI|4uXljYN9-_X~tyaPKm$fSN0IQAjy)X+R=?Er6)dP!kF=j0+S z>P8dfhm+tFVEdti<^ERpi5I5jJoa_&Pom${GH1#PM$z*EIZ@P&p>z0Ohd%deDVAGW zZ6&1!kWx>`s7+*Po7{xDeCs$ge^k-RcI-QH@6Ds1W5@||0}nDEU5%(Wm#5*!G}o~+ z%M`qVej0Xug4x35i~bGbGh#kN@8If+XO zd}@{CRF+FRwf)o{t^T|~%?};*py9$Dik5aj+ZsJjbh*WKrvSaN|Kxh{3N`Cz?@(}j zC%9C3&R621+ipw2*tFVrlUHuv1wY&Jri!W`9G5qVE^S#K-WsPIZmS(o>qt}VcetW} z`l#PN1MO!OP`8X6bd{QNYVcF131@GC7v$^IEz;Jk{L!yqYaY&V=+LW;*XVoix()cB zhF|oVk;jZ!A|>aK@e#qmxPsGD*iq_p4;<0hHQ(TPm}lwH4gRLeXj-G&Lv+&XAM2#gTH%4wMdj>Ug{bMRVbrL>xd%zdNc;W92AGD#Ld2a?e z4?}F5kH3fJhDYANaEIx+&nRjhkw1N%{E5$CKTaU0)aB?Qr2ZPRk8Q7wAVbr@N*@~C zPTW;=7}>J<0^kp)`mvXPC-=oYirdsW6Y4}xz`F_j2J7EtG84eQxu1?>F(FEbd@bP{QYZrkY{06)239$R=H1iST^eLvP*H;zLj}NF_T7AaqmhBL} zQXc?7{EWvDc&N?Rmu}M9#MKI#2MEWwhF^}CpOy3cZ{ugLQd&NduYmzl$AKqH$GA2J zf9P+WrrvY=-^jWDUvj^k)~FkfPcsuTMSa&~*8HW_!c3kF*4}0qU~hBWLh5YuYR3cg zT%a3$2kW)?%z9YgBW30yVK={JGY<*&$g4er4H+TyA;S=JqIXU0lq4w=}C_IL(Am+~d z1Qx4a0Keg3@`UbC4{N1om~lBu&6xfl^e#J((l@!6-)q3mTuegm$jwCl&+b_-!~9IzKz@*=a1gs(q5nHD zs@6?kQsdA6Qtpn&=*2S2gUvGO>B4Jp_qHw%;!a5oYK!&wAh0t>1H2XIiM;O-GNq;mTa^m&e++b)%+KdM%Nx?8vk3HY}8SY}YX$`cBU&v6dja^7}h)sFS1rXE++ zPd#q&h1_3sgdITmBUNt6LOC^T0-*zKtKomaaofgMZy>q{vip^!L;nxCXt% zHd&9IRddbr@r8#!Pv77Q`d42;M~OR-Y3rj}t=FEh->FOedzpA?bf(+iLdNpa-JC}X> z7p9*mA~0ho=wZ1P`t$BcF8ihfUhzTl#2vZp=l!Xi>n2~&8rzc=v6ZDEU?k2f56bVq zSHYQwu(#Noytf9=EXK7sy$5w3LtaRKlO?QX-p8oK`*I%mDgFw(X}UXC`7B5D2ik}9 ze(T;o@YzG3VG`QoN9lppmu^IlugZ@$lVG{5@g((Ea~ovxo%dhy5&4`5xLd8h!}}R= zVK}=>?T7zRtsTFQuXu=JcNd!1fsLS5R$C(M-oTq7&LqiX$|xjixXD+`~~{MmP?H2ZPI-bgN22tYo| zXSUAlj@izndV*f&EHDwjnT+J{Bd3dd)O!5))x7(^%Q=1v`S1eqAhUm`_A4Ae4ZlpT zx?Hg1`SNe@C&W61Xg9r$59o}G524Q!8~o{7!svo%Zv@McAQSMuH9at+a zdZkK7-z;b1BiJl>f!?I%Pb~+9eipMP74#vGzgOk$`-B=d{kU4UF$dWH0I^E7t8aOX zWiz*kzI4`+)m?O$T35KwLpY0$+&bt;c~)G}s{uJG|xj zb<;cg3{fx!9?kqZ01}sts+5EZ5SM|vnTFTR-5Odt-d+@335<~U&!Hqp>;KMe;#`i zB10~)FQ}bbzl|6k9D;03%gwK9vT(JQN}t9K(et6_-huXw_LCZ&d$&%FZqww_Rq`C` zEyE+jfm|g)XJdF41?U^LkP%mB%r$q&4|2N0=U%-j zMe$#@G`R5VYPVj3mdJ&P8G2wmjoHK2DYeHxr1}eQQtSD*kpta~ zEo$%`U`HOiN8T|rU_L#E+wK|s{ATZMc52tVHa5oYGgo7|3-VhCcWQ{4gJJ(#^n~?Ad)I_np2{TMq3$Q#ix0%?d9?g5OpASFAlxHnZw-^PUL97Ix zn{Bh1g;I1-CHP>px9G&YpY?6sg!&)xlErxDn+=B)*nDz&*K)RCg*o6^waJ+s=7DV< zB;tOIOqve(#ru(;|3jYnXTZE49Y4hE*lYgzJm#)K;)!@2JD1~Nda$Uf|Afl!BWeUMLSyEDj26(@;;@8SoJ!?k zEiZjS%d7tv*?J7VQWGW4i%r+DL1Aq-zKU2XV#cI^O+ND9)Oz+u$SL1N-1H1GflhA% z`^EGJ#hgb-QjTlauNa+~6N!hk7CudX{2BZi^#Nf&v3Yf7z{hGI&_MCsnyN8Bj&JMw z7xW3~S)94wB%DZXiFdy=?#uwhBlfyrx{^9?qiTVGDJz}1nTAt;`d8|rI zoPcYLoO!d?sd;3Z>M#DVoKx?n-p>49OwY;mcM~3*lb=ma4E8Sk_~7_Ko$%fZ4!@-F z;PYyv)GpCuH=ALe#~6b69#(&e#Xl9=@8{ira~0Ee=ImyCmHN%B?T;;5Rs%*_4)| z2Q(estU~gXoX!gJgMKrQVYzZM#+F3W=)g&0rI*o_8DxT)Nt>5*`&F*o!Ce0Xz&p%b z#$GKIJ|&ySSi(j*&XHX2^0^HA`;GeHe2)Wi0eER}ydL;1I(h{M{0;Gf-znxXM1-xe z`KdfEM>cJK!DMHw^%)H|Kg!<|+)VyI2BsE*qI;h#@59!RrHuaDGs7`ZS zT)U3HQ?R;#=>zu5>RKjWW&?5=?)riY^mS{ppSxr5f9uY-P!8Ln4By9+vQ9HPtuyWS zGXwJD`3%Uh>J|J=#l85dx)~#4B5Ye!(rWojIywHIb!6lXIy}ri@UQJz(Syb@s z&I$2sZo9ENX3yb4p0l&gYsCT9U5LX5FMD{IPqA-TqL*~6d8M8yy;0As{-6$)|EuO* zVtD4AtOjKI8b*s+C|;}nski9x*!Szu=nruIHq92V!M`o!df)T0U0o%BfIharR=CeG z;o=iR$o7pbUkAE4$+#w+&+A0}Jvv&uQbWx@Q3+dXb2u!X?^biKP_r9fzDfggKclnr z@6_zt$5eB6=5bH&o8Qyp20ke@DkqxK8uoG#xv4VGWObu1{eZ|&fKMTQxzc)Ai{ Date: Tue, 11 Nov 2025 14:44:15 +0000 Subject: [PATCH 12/13] update index.md --- docs/index.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 90 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index 81cec07a..f102ac54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,19 +1,97 @@ # :material-rocket-launch: Welcome to Mindtrace -Explore the Mindtrace Docs, a comprehensive guide to streamline both hardware and software integration, as well as machine learning workflows within your organization. Whether your team is deploying complex infrastructure or experimenting with new models, this hub is designed to help companies unlock the full potential of Mindtrace across their projects. +Unifying asset inspection under a single package, Mindtrace brings together industrial hardware, machine learning, and automation, bridging the gap between edge devices and scalable intelligence. + +Monitor, automate, and scale your on-prem AI solutions effortlessly with **Mindtrace** package. +From training robust AI models, hardware integration to deploying and scaling edge intelligence for **Asset inspection**, Mindtrace enables full-cycle orchestration. + +It seamlessly connects **hardware, data, and machine learning**, empowering teams to deploy context-aware decision systems, derive real-time insights, and visualize results through interactive dashboards + +--- ## :material-star: Features -- :fontawesome-solid-microchip: **Hardware Integration** - Seamless hardware connectivity -- :material-brain: **Machine Learning** - Advanced ML workflows -- :material-cog: **Configuration** - Flexible configuration management -## :material-link: Quick Links +- :fontawesome-solid-network-wired: **Unified Architecture** + Integrates data ingestion, model training, deployment, and system coordination under one modular ecosystem that scales seamlessly across services and clusters. + +- :material-cpu-64-bit: **Hardware-Aware Intelligence** + Connect directly to PLCs, cameras, and sensors for real-time inference, control, and closed-loop feedback across industrial environments. + +- :material-brain: **ML-Native Design** + Provides end-to-end pipelines for dataset management, model registry, and distributed training workflows. + +- :material-database: **Datalake Integration** + Built-in connectors and APIs for storing, indexing, and retrieving structured or unstructured data — powering analytics, retraining, and traceability. + +- :material-cloud-sync: **Cluster-Aware Orchestration** + Enables coordinated operation across multiple nodes or services, supporting distributed execution and horizontal scaling. + +- :material-account-group: **Service Collaboration Layer** + Seamlessly launch, register, and interconnect FastAPI or MCP-based microservices through a unified control plane and shared state system. + + +--- + +## :material-layers-triple: Layered Architecture + +Mindtrace is organized into a layered workspace to support ML components as Python modules with clearly defined boundaries and dependencies. We use a level-based system for organizing modules based on dependency direction and build order. + +### **Level 1: Core** +- `core`: Foundational utilities and base classes used across all other modules. + +### **Level 2: Core Consumers** +- `jobs`: Job execution and backend interfaces. +- `registry`: Artifact and metadata management. +- `database`: Redis, Mongo, and DB access layers. +- `services`: Service base classes, authentication, and gateways. +- `storage`: Storage functionality for cloud storage integration. +- `ui`: Optional UI libraries and components. + +### **Level 3: Infrastructure Modules** +- `hardware`: Interfaces for cameras, PLCs, scanners, etc. +- `cluster`: Runtime cluster management, nodes, and workers. +- `datalake`: Dataset interfaces for HuggingFace and Mindtrace datasets. +- `models`: Core model definitions and leaderboard utilities. + +### **Level 4: Automation** +- `automation`: Integration of pipelines and orchestration using level 2–3 modules. + +### **Level 5: Applications** +- `apps`: End-user applications composed of all previous levels. + - E.g., Demo pipelines + +--- + +## :material-arrow-down-bold: Dependency Flow + +Each layer only depends on modules in lower levels. + +| Module | Depends On | +|------------|------------------------------------------------------| +| `core` | – | +| `jobs` | `core` | +| `registry` | `core` | +| `database` | `core`, `registry` | +| `services` | `core` | +| `storage` | – | +| `ui` | `core` | +| `cluster` | `core`, `jobs`, `registry`, `database`, `services` | +| `datalake` | `core`, `registry`, `database`, `services` | +| `models` | `core`, `registry`, `services` | +| `hardware` | `core`, `services`, `storage` | +| `automation` | `core`, `registry`, `database`, `services`, `datalake`, `models`, `cluster` | +| `apps` | `core`, `registry`, `database`, `services`, `datalake`, `models`, `cluster`, `jobs`, `hardware`, `ui`, `automation` | + +--- + +## :material-link: Useful Links - :material-github: [GitHub Repository](https://github.com/Mindtrace/mindtrace) - :material-package: [PyPI Package](https://pypi.org/project/mindtrace/) -## :material-rocket-launch: Quick Start +--- +## :material-console: Quick Start ### :material-download: Installation @@ -31,7 +109,12 @@ uv add mindtrace-datalake from mindtrace import core, registry, database, services ``` +--- +## :material-rocket: Contribute +We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help makes Mindtrace better. - +- :material-book-open: [Contributing Guide](https://github.com/Mindtrace/mindtrace/blob/dev/CONTRIBUTING.md) - Learn how to get started +- :material-github: [GitHub Issues](https://github.com/Mindtrace/mindtrace/issues) - Report bugs or suggest features +- :material-source-branch: [Pull Requests](https://github.com/Mindtrace/mindtrace/pulls) - Submit your contributions \ No newline at end of file From 96cfe98271c9897edaf2fbac8cf61e3633b128f6 Mon Sep 17 00:00:00 2001 From: Vikrant Sharma <7.sharma.vikrant@gmail.com> Date: Tue, 11 Nov 2025 15:48:30 +0000 Subject: [PATCH 13/13] remove feature branch from docs workflow --- .github/workflows/docs.yml | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5c5286b8..50c83ebe 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -5,7 +5,6 @@ on: branches: - dev - main - - feature/docmentation workflow_dispatch: release: types: [published] @@ -15,9 +14,9 @@ concurrency: cancel-in-progress: true permissions: - contents: write - pages: write - pull-requests: write + contents: write + pages: write + pull-requests: write jobs: deploy: @@ -58,11 +57,6 @@ jobs: run: | uv run mike set-default dev --push - - name: Deploy Feature Docs - if: github.event_name == 'push' && github.ref == 'refs/heads/feature/docmentation' - run: | - uv run mike deploy --push feature-docs - - name: Deploy Release Docs if: github.event_name == 'release' && github.event.action == 'published' run: | @@ -72,4 +66,4 @@ jobs: - name: Deploy Main Docs if: github.event_name == 'push' && github.ref == 'refs/heads/main' run: | - uv run mike deploy --push main \ No newline at end of file + uv run mike deploy --push main