From 0d65165db0b3a881a4600ce3683b1051dd2510db Mon Sep 17 00:00:00 2001 From: Puria Nafisi Azizi Date: Wed, 24 Apr 2024 00:22:57 +0200 Subject: [PATCH] feat: revamp the structure of docs site contents (#13) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: revamp the structure of the contents * docs: new image for download microservices (#11) * chore: test pr preview_prs * install vhs * add ttyd * add it from snap * boom * order matters sometimes * path matters sometimes * powers matters sometimes * sometimes stupidy matters... * meh * mah * booh * docs: aknowledgements and microservices deployment * chore: separate deployments and add /dashboard section * yeyeye * docs: add image for zip download * Deploy preview for PR 11 🛫 * Remove preview for PR 11 🛬 * Update README.md * build: deps * up: patch * fix: paths --------- Co-authored-by: puria Co-authored-by: Andrea D'Intino --- .github/workflows/preview.yml | 2 +- bun.lockb | Bin 47254 -> 51339 bytes docs/{ => .archive}/quickstart.md | 0 .../.gitignore | 0 .../Makefile | 0 .../didroom-microservices.tape | 0 docs/.vitepress/config.mts | 145 ++++-------------- docs/.vitepress/theme/style.css | 28 ++-- docs/404.md | 1 + docs/aknowledgements.md | 4 +- docs/core-technologies.md | 58 +++---- docs/get_started.md | 69 +++++++++ docs/guides/concepts.md | 1 + docs/guides/index.md | 1 + docs/guides/orgadmin/auth_server.md | 5 + docs/guides/orgadmin/create.md | 5 + docs/guides/orgadmin/credential_issuer.md | 5 + docs/{dashboard => guides/orgadmin}/index.md | 7 +- docs/guides/orgadmin/issuance_flow.md | 5 + .../sysadmin/deploy_microservices.md} | 50 +++++- docs/guides/sysadmin/index.md | 21 +++ .../sysadmin/setup.md} | 17 +- docs/guides/sysadmin/setup_dashboard.md | 3 + .../verifier/join_org.md} | 0 docs/guides/verifier/register.md | 0 docs/guides/verifier/verification_flow.md | 0 docs/guides/verifier/verify.md | 0 docs/guides/wallet/change_language.md | 0 docs/guides/wallet/get_credential.md | 0 docs/guides/wallet/join_org.md | 0 docs/guides/wallet/logout.md | 0 docs/guides/wallet/preferences.md | 0 docs/guides/wallet/present_credential.md | 0 docs/guides/wallet/register.md | 0 docs/index.md | 6 +- docs/intro.md | 47 ++++-- docs/solution.md | 101 ++++++------ images/didroom_logo_emblem.svg | 62 ++++++++ package-lock.json | 121 +++++++++++++++ package.json | 1 + 40 files changed, 530 insertions(+), 235 deletions(-) rename docs/{ => .archive}/quickstart.md (100%) rename docs/{installation_instructions => .installation_instructions}/.gitignore (100%) rename docs/{installation_instructions => .installation_instructions}/Makefile (100%) rename docs/{installation_instructions => .installation_instructions}/didroom-microservices.tape (100%) create mode 100644 docs/404.md create mode 100644 docs/get_started.md create mode 100644 docs/guides/concepts.md create mode 100644 docs/guides/index.md create mode 100644 docs/guides/orgadmin/auth_server.md create mode 100644 docs/guides/orgadmin/create.md create mode 100644 docs/guides/orgadmin/credential_issuer.md rename docs/{dashboard => guides/orgadmin}/index.md (65%) create mode 100644 docs/guides/orgadmin/issuance_flow.md rename docs/{microservices/index.md => guides/sysadmin/deploy_microservices.md} (54%) create mode 100644 docs/guides/sysadmin/index.md rename docs/{on-premise.md => guides/sysadmin/setup.md} (69%) create mode 100644 docs/guides/sysadmin/setup_dashboard.md rename docs/{deploy.md => guides/verifier/join_org.md} (100%) create mode 100644 docs/guides/verifier/register.md create mode 100644 docs/guides/verifier/verification_flow.md create mode 100644 docs/guides/verifier/verify.md create mode 100644 docs/guides/wallet/change_language.md create mode 100644 docs/guides/wallet/get_credential.md create mode 100644 docs/guides/wallet/join_org.md create mode 100644 docs/guides/wallet/logout.md create mode 100644 docs/guides/wallet/preferences.md create mode 100644 docs/guides/wallet/present_credential.md create mode 100644 docs/guides/wallet/register.md create mode 100644 images/didroom_logo_emblem.svg diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml index 29b5f0d..8df7582 100644 --- a/.github/workflows/preview.yml +++ b/.github/workflows/preview.yml @@ -39,7 +39,7 @@ jobs: sudo snap install ttyd --classic sudo apt update && sudo apt install vhs ffmpeg - run: make - working-directory: ./docs/installation_instructions + working-directory: ./docs/.installation_instructions - name: Build with VitePress run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build - name: Deploy preview diff --git a/bun.lockb b/bun.lockb index b60c48abb01eb818481f14e534227dc709500c13..07bd16316ad78346adeefee56b5e25c4629479d8 100755 GIT binary patch delta 10638 zcmeHNd0bW1_CM!%uQCcK>IE(e0#3-RAOaV00>pW`niB}9S45Bt2q@mGrlN?c%Ss%c z*~@Y)&2k{^X_;lI`RtWr+F+JFH8m|Y)8BWU!HfOsefqrLd;k6R=YIEEYp=D}p7+`3 z?(^JDsd`z1rQz+bMEv8dZ$)tDvit_(;x+f43wfsO@U8IZPs1;bz5k+jZOdQY7vwN& znYop%VWlEC;?j~_S(uO5TM+CwK)pbRs| zTU9QFohQ<38z_EmfO zXkwvrR*^L~3?5x5L=3XI!pt_E!hIvq3^)C?K`8n33e0BsHV zE;^sIncD{pW&mlSY7|Xq!FPI=;j*B}X`kp65>f8)#F|Eui?>Yt{65 zs$2xh`b;&wubLhU+8pVvRoNA^1>`$0=Jc;XIp1+aP}%o^HW6%seWRMN9Fz@hp!nG* zBWeaZ9F#M317&?jRrUqt3R@>x@+=sj)96#~^pO}z9?bl#qP+0QR$+iD7iWzhpEZ6; zZUSWXhglbvW6RCA{D^+xQH+2By=h;Be&f+C1!cpQNaxv-hyG>yIVh(WO~}bcxxz`v z=uP`Opqww?Qe4dGlL`v*xIj1L=ZfA(1)2UFsFZUV)W#0Kfr4B5k=la7qTH-(xOjwt zWrw$el=*uAlw0`E5TydUKzWXg1m&LDfeFHXK8DO=y%Ln?zYCVkUMvzCc0NgEYSrH zs=Tyj!^$?JIy74{efN0xBcu2A=(XqY_N7bD&A;x{rmTf)E8hzTvX8Y|R6Wcde=en2 zx9t_1mM%F{?Q!p~Tcvkt@3yQI-9^dc`lrL+xp0_5clmopzG2=^rd@^lJzg4 zgZt92jS}=CR()@oOMT3(1D7VJHO5}il{qnu%AJ$NMYI?3QM!lNhvHq5^}`wnLQmOt zGdRW5BXHg2TqzXqnyjC$Q#Ild+6&o5F9?a0WK0l;QoLKTSViTCFVSANWcN613K{4O zR6%G?I~s-3jYdxHHApof6^;afW*d-da26X?(`_pkwuiKE~A#u$(xS)1zsnFTk z4da@qDdfs+Z|3ZT#IBr32c6@jIWE-I-6WlNp$d>7SE_S2>Dys8j-vhU3HrIY8qg6l7*{q$Jd9g9iz0#30z0Z#GfjU}a|jRvRq+Xzm{ zaUEPA*gI;lZ8>Do(9Uru&t}RWHM-WxCH0gT6b0y%Eyayk1?(GF(psXDOZj#Ks2X3s)1$EHMEdi%^c^6!~T-yg7s3ORuuf|?! zrpllM{a4_IFei=gNL_=w+IY<}c-3Rk$vhrJf&^f_$P_DqPbs{=%i+&Z_K8_1=f}Je zc->=?$bl)B6^v()Tp)Tv4)rN#Kp)6~Da&ZJz?)bYz=0`OG=c>Lrfi4NmjhGQM=PRC zSs$ayF({uOtGvVUV-$}hB{1dmOhx?fQIs!-%zr_#w1w%a{y$A^|7nN6=a0L*Ol`n# zXt=CkgL2h?sRvL6@YpQ^SYHk3XnzMB;=w(qralkK;m=U^Rtqp)4REMWxs){k>;D39 zVCn?C%mMrVhY z<^Q3|r+CV8I0dl5S%4j!SLp?ng2;Nd;U4>sEp9HKof-fx_+PAU*{=SghPl8pxAfm# z+_pczy8kPS+a_e9_8cfHJ<9t3U)+Ck zako-B@)QWKvH!KWch-guZPaZ`Bhn@HxcgGy)3>_a62DCAcg(i+`S?%w-2T90_4+GY z9vm5zb4WjOd)$n-53Xx9V&VB^;nr8CmMz|Md7L3rHzg#4!eR`z%MV}Az2F==eR0sV z$s0R_@6=Cz=R4m9XYUq&mU7C?xN7_DGtSK}RYqSc960JwWcT&HxiyxU&o;+Vlu<>lu* zmw9a%cV@?^jlS#Rw$$7|{L<`sSGNz#8}e55nV^MvN2<)hw?w)S)55m@#?LS3{OG%S zT}@kY!CHfH>!G(S)AW;udCqY6o!w$(`&Z63nP2&JM&{9X+C0Cn(DcQoS)a5SwPg6x z9P#^Cubg&US+9CN^{ZEM=*_xu`*%&8`}2y2?-wLjH2GrsnWsB%`{?x>pX`p`{kMRg z32zK|`P>1U$3M%y%r#rmKGC-beaSp;MMQI#w^pPssaR0YF>ifZ&>e06$*$4;UT~Ug zE$fgyVWpTg?OMrm3%7)~7{4#-`tT_i+r3dl179dy{7b(Le#zV3^jZD-ju8!Op4oXP z?|%8|37^*0^NRzLy3516?ow0lj%WQoyQ?3!KB!0I@y9Z6Zu_=*=n1zUCSSLoz1?@@ zn8@$mm}Oc>S1+`yE3Bez zZr+Q>KP(*lQ$5G{+vsu7mF3NA(fA)5K6`uaqFLQ$d^@UVQ9s+sVPB=Vef)*XCqmC_ z#_&r&`5$yy8}q~b&J~j;Zr&PT+p%-fE8Vvq&kx$MVZ|5h*QQP_ya_xGy1%ZN^wE}n zeot3F81j-+gNoEHUrp{k_}q$&%%{#rpG)7gd(4eyTh@52^E1t;x-g)i|E7IjuRXug z^F+(U;@Ty$Y)fP4=zxIOQ=X-cHP>}etYu1-_z}lm5ulKZYi;K+48Jk{K7YH-m2#~fWC}2i-8m$V-{P} zGQ>f21#vK?bTW$}RExL`-9+4$(mR{QcC;RGd%B0X0}YBbi=ng$aYqv4%wiagL>x{# z5J!-67qb{iS%{-(FXCwOiZ_cfWI^1C4kGSMK3&aXEKNfkM@JBMp}+*Q7*FMhyVBng zCs6xDvzSP;5hu|Z#3qVLGK> zO6lFq_-kW5;&i%)xDO3VF^d_rDaA}5^l~Tn?ipe~8rj`UWxd^LKcoTV+`~-mQr#)P zM}|0v_Ch)h$-ifYID{-c%~X}XPnGmAx`VGaZ5S9i*_{8RAGP?`@`) zecb7DNTaBIs+rO<+^HrtLmWeAAl-$Ol$IfmqlIZ^+Su2fu0hJ8_;fRk=;uyr(=)_u zx&q0mzdQBolOg6(Z67o3f%Ge+iIkpUrbz?bXw>!qLnNI%wjPeL|j5X1I=P7O+!4L zjvy|hz(HoQoXQbb(BBcyp!S2!;!K*2xN_&2!G5A%hlfHlT0b* zfV3F@^ys{_KYjb+%!;=+{_n*K?9@o{}EPz$UAo&oqpVKGnxECKjT!tZyzfZjkVz%P<`NfttZjsU-KVAJJ)F8LpD z{sU471o%ytA8z~_unt%cYyg&W_bvmo93Wr?ZL>!7$^$nA$OonZ1wbJ%4JZPv0RCGQ zN`O)z7zhCd0E2+R0N&26G4dHV3KGBJdI5ZB=EvB1;B(+KfOiq$6<{N<3D^v50k#6K z0z)s)|fZv^>fe2uu4G}`Sxe9ejEQyIW1<>lEW?}$sC|+l44h44$mu>*K zJNUWBGItqo&{~(3gXfvm56A(sfJ|TnFbv@K4FtHo{eiv!ce4nn)8!FQ2u~mgXw52` zUFz5H5zm#@6js_cg~yKH9k@%{0NjDxkr_ZAARR~pc$|5>djUNDJ%H{&3f(D*X~$LM zF6U|u1%?1x6*S6K<$9MCe21V0WK3yc9q15W{LKMK&=mkoYAz-^ug zOaNvA6#(~}1<(p+Iten*6P`=Od>-I=JRPtCJb8)$o@~>ALZATP3CI&~GQb&G&uJR! zIh6g>_wn2OoR`buyp#DnqA-eMcJ5FrJUi2DSjRF~WQNLf3ptHxCBW$nZs~}*h!70C ziV<8AM@7euDd}Pgh>i`gS}JnMr!1hgI5sLgGCW#&nZ>fOYyb8;u_ih?Jd#q%{O~Zc zRruiF@vL$mZ0pO)e6Z1ODf980569lfReNLDu-9&0dRY=gWtfriHiqyGm5A&+*Ms@)PH4{~se`8t(vQ?+{{E+-N0 z;;;j%H?EJbl9aY0lYI4x?$<7rBypBHq4zsez)VA|b_+K<=a=D8?^`~A*O+iL+Hu49 z{e~A}x1KY#;PS#ze?j=hnWiGEcEfk=`+RTz$#cG9gBZC&+8yAjria`1Kem4zG@YU7 zguUB^_RTaHwadqCYmzt2iS!TStdZgIaGu~oH)a~70WRcH87+-;Ayef9Dcgl!u3Y8) zo{MtzxGdtSnl^7H#e0jdyU@^C0n!NciU<%+F?n;?9L#%db+_3m$&XnUnN)7|_2rZhr#n4*9&%{RZu9`v(yq3b&o+*nReGnL!(g==McNIq+Ff{Zqd^mj zs*dD147A&F|B3J>qP7m z@>bEYDIK*NjM{zkVAF|EqrcZH4uj!Mm(MoDYWLHB@r$hclISiCralvlco4B!4!~Dw*&GDwRX12koU8BFaY1ZWH zP9Y~926vj$3Ha9T-T%Jc)BjMrD+3$`+Rc22ChcOx>aW*3G_l^)a*iQZyUHKm{DHGa zEAO8i2ASBhn_$s=`&{v@^~pcI<pieU3po?MzN{qooKJN}Owuel*f>NTNS20`c^x zw?VKtZq1E0`r#0S6=6U7S>uWqhaaBlEq34s8A6CZb$i+%MflTGPe)5#{AtP4hP3W5 z_k{Vt1##6Y$F6$TVSW}GeoFm3QNOv?_vl$~@nfX8B1QXFWm@bnSLa^-ahIof-Jh;M z9UzsqB+q#UqxSK@H-~=iGg{h<2Zp+g1-0UNt*C5XU!(T1z&`V>V>#IqC(3(?ypNx3 zMPJM_NT1`LZJu4a97r?g8>F8D>ACsQ(xcY&A;_E{dN|(@t6jst)7*8r_^GWQ%EFF; z{any4>MzfAEt}cNp2E);Cp~0wqXYhLBFVptKhCYz60Y%5~3{g`uGyiJQ!s`yr z$`HC*Wsr7-(1mJ)^l=CUEHp^}457@$S_4$?nu%(ul0Vy2r6tl6^)>!+eg9Rhl*US` zN3|Ymjh~d10Z_-`_cJ_MuP3uVsZ&eH4y9Q&2AlRZNoioS!)b^17(GQ>s4}^-iL&ocz z{fDZ96W%r^xV~pt&HIxe{P;fgSrXyN{|n&zAFDOYYRSnRpGAQ?j5}8>ks8vS)qZr~ zSzV|4+Mz^rCbew#$@TSMZW^ubn7I7RKS&2eG5WyQJpZq7O> zYs!>@=@hlvubFxZL?)FB!>&aqmIuZ@X$*rW6T;+UBzv`3!xR;Ndc{s-o=8E?C*&|b zOGa_V@s_C(>OmO)_2J(zRX`4v3&V*RCnh!yk6?3k^5848Tx)686iZH4ajvFOWP0J* z0B`j$%9U1*rRZ?VdbM>M?Enjn#>(A;M+VAZ+o{D9!niX2nlRZ4V}~G{$Lw6bLKpl$ DzzxF4 delta 8068 zcmdT}eSA!3+CJwnk|19s%p@b31o^^9CX7UqiI7H^5Rov5AS9_lh$Jjqm5B(65R!Xo zV^wL@SJ9TfUE0#>+R|1n>qkHQmezLLMq5RfR=@0ZpASP{@B6ClKkxa?^<4M;-1qbS z+|N04PD4|hbyuY|=IGEl1-pDle=?hvhUcE1us-UA`5&goeiYPL_4L$5&-UnKYqwvJ zuZku|XjNpnqPWxf^NM9<9?}3oa9sfVgNLZRNEC!l&=a6{0AGRb4gQD9#j`7&mCoXd zvziV+KiKQqDD_+b`$C^qQBk=twyaplQ!6f;Q&EXb;p?`7&>jx63un)9774;G=pCW& z*9k%}Jt}suI^-n?-H`JX*a)sw^;uv8^pW5Ya16KyxINee{?b#)e;XVQ{aJ7*c%{m- zReQFo$Ah_kJvbQL0gRzmxr!^M&U4Nx5^6CqJQwBQ&frO4p0g}9KS9-ds`k!m{w+)h z`?Z3*fX}G7OzMAn6m@BY=*|8fq5bUMezrjqi{Q{U9 zd>70eu9)te>BPJ@v{M$ZqlYr*rG@1)%`++lN!2S0r%o-LI;;3H{J1CQpQkfkuJbfzphAt~0~xAU$;Qv8w-V~Vv3l2YO*q%65?XY4N}FCWrKId2Cf z#d;l*S_}5A;#UJnsqg6RJYVcGr9?g?rNm}P!{z$EfTWa-$L3P}svxO-fh5-_bgOjBBdb$*BllJN<#%PmTVK&;ldSavE9Cx*&IIL%ZfiA%|EQn&d*>wA` zIaBB>BX%LAL|Gbv=uTrvY7C~B5S#RVFwFqcL*NtLKHpw@HW`J@-Xs5}hdkI09NPPm6yuOAsM0Sn~ z9H6rx#)iowdL)!~hS{VyLg`YNP4^x0Q)qWslJt^^W`x_MpG>qf+@{-$_(iycC+WV2 zG+LIjx^q7{?{P@OW$7ZMak4ZJQ94nU)EDmu`b~D$S0h9-4Am;*e`N<>;nO(2_H!E#f(4}Fe%(#m4GqG z*PYA-Fb?@*MmX_qk~=p<&XpHV&d*cz2jeP1eoEjv9;^bT9FKOU+L2$yX#c?q{zm1v zeYpcX<+E79buVUnscco4_r)TB_sU{`?OYkoc%cU1>rQ6-Qh@i`3V`(nL9l>i;s0cA zXcZvQs+drD+cwK(1c8~i?|M~d=I-qPu*HO30AKfF?#6C_c@Mzb|A4B$4Ce9&0dD;@ zfc;+Qk+N_YV22|BkNcRazXRrrne8V4uHdA~e^VJG=d+FH<^E$(Ubg=|D7oSL48mU@ zgKGPHdj1AM`0Hb@>R!S6z(I&X%mnzlPp-OO$6w{gd+J`X#~tH*wkt7+`Dfub3PRNM z|1bt^|5*&~JJ2`JgU$@J)3^cN)F;U9b$KCLE3|^BJD}T206qC+Ke=kZX%7MoHU0R zO*@drkT}>O_M-7fd(#U@`;gZVhiIlkqDhpGR0*yJWYNL;lrc&ZChd79ukfu>9 z(!rEA+=1uw7NqHP73o7X%^`bMJj`CE1U@dV{VALsYNBbR44JpQ;MaNhHuNk01LJ1dJh0%JUI|AALmelVkx z1)jR2$no75H+hIirpXb0PfN*;}=;-{)8AR34PdI7zGK7bkM3*b3ghyyG@JkSr|{_>rLZ+HAy z$hWOEKohVEXas5izCpNvYG4V##}_}rB?1HS=R-(>-~$8!c=qRi$o%hEFaZGo{*A~t zb^@;jT7acMEwBt&4%E@di{q(maqp_`(0TxTKY9qr0EPmYz%XDqUmT+8%uEv(fF)X{Ub2BmPY_Qv*^hzrxj;m?nAcSNo*SbNj! zJ0#tVm zPnVyXxpyL}i!)oyv4XIlvX>jI+6%Q$YdS1g)X$X$d%W4ocI{nYb!R_O3c-{pHJpHl6y}?V!EQZdduYqFE=tk=&M*p7djb-l)C)PPp<& zwvXTPQ*MX1Jt=mj-m1MX|1_ib?i71#U6cYbs`9P(;jrMGJDu+N`= z?TKeC2NTp7-N8JwjesmIb&q1tqLO41PByaE6uJlv4gZB3R zTun(v+`11ByDe+|D5Ozu)n4~Mo8c@dPmSE*cF;ZuoZ9Ty?MPH>w%c;Xk7hOMjoKH4 zSyP_6b++k1n%m))A8kV2+9!w4)>U5HoO685jE^u2C{OK}^YF{x9 z|Fda(=dMG)bvtO^IgZ_Mg)Z7MhTN8Ne@b4hH)PCW8jFMwngBXspvE&k*A3*?qz_nyn`i(Q>)VHQJ6nQ|e;6Px38LgC zy|g)q#x|L(+GmWCoD&h{ol4(9FvlX=EwO_3q2r%Nz8yYMI)KCQ7ab2V(nn2M(mW%X zn=ui1V(Nf~R%H1NT@Zd@5}yhPUvr$W#z<3}T}J+(;SYzFGmn*B&u}zLw@>k%A@p;z zMcNxm7P1)oo0QK57U_8Ab6I9Tw2Q-qANaCOf0(=9+UrLNrxk7l2uzZ+rnCHy*u)9Yw3Je*8x^;YdG&8m5eO1~_xzwCC` zzT<59=;UV?b~rb=EzWSdvQ}@@KKPs&->)|F{MoH;hmGMh<#BCHT7ya{>2A7f^v3^r z^vd9*dkw+(pLbN9615Svhw32i)|6#ZS4*98ZAfZ?ySsXK@w;tmfi6)L+oG@1zK_ih z3w$&4$bO@rXo*rb*Dtr9+wve~K1Z#6up^I}mk)K6bUvZRflk1)soWDurER9>_4@Ym zUme&6HR5kq09n^thU*afyy+jgo~{qO^rxNv&^trVS^L=Rlil(M^nmUQ{o>`Duf)7~ uZGJp-JodW2t~*?E$e8q(vPRU0>*qhwwe@`|d{gkg5r350J>9US$G-uD=U@B) diff --git a/docs/quickstart.md b/docs/.archive/quickstart.md similarity index 100% rename from docs/quickstart.md rename to docs/.archive/quickstart.md diff --git a/docs/installation_instructions/.gitignore b/docs/.installation_instructions/.gitignore similarity index 100% rename from docs/installation_instructions/.gitignore rename to docs/.installation_instructions/.gitignore diff --git a/docs/installation_instructions/Makefile b/docs/.installation_instructions/Makefile similarity index 100% rename from docs/installation_instructions/Makefile rename to docs/.installation_instructions/Makefile diff --git a/docs/installation_instructions/didroom-microservices.tape b/docs/.installation_instructions/didroom-microservices.tape similarity index 100% rename from docs/installation_instructions/didroom-microservices.tape rename to docs/.installation_instructions/didroom-microservices.tape diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 45dda29..4b6fd8d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,4 +1,26 @@ import { defineConfig } from "vitepress"; +import { generateSidebar } from "vitepress-sidebar"; + +const vitepressSidebarOptions = { + documentRootPath: "docs", + manualSortFileNameByPriority: [ + "intro.md", + "core-technologies.md", + "solution.md", + "get_started.md", + "guides", + "sysadmin", + "setup.md", + "setup_dashboard.md", + "deploy_microservices.md", + "orgadmin", + ], + useTitleFromFileHeading: true, + useFolderTitleFromIndexFile: true, + useFolderLinkFromIndexFile: true, + collapsed: false, + includeDotFiles: false, +}; export default defineConfig({ base: "/DIDroom/", @@ -11,126 +33,19 @@ export default defineConfig({ themeConfig: { nav: [ { text: "Home", link: "/" }, - { text: "Reference", link: "/intro" }, - { text: "Quick start", link: "/quickstart" }, - ], - - sidebar: [ - { - text: "📖 Introduction ", - link: "/intro", - items: [ - { text: "How it works?", link: "/intro#how-it-works", }, - { text: "Features", link: "/intro#features", }, - { text: "Integration and flexibility", link: "/intro#integration-and-flexibility", }, - { text: "Architectural overview", link: "/intro#architectural-overview", }, - ] - }, - { - text: "🏗️ Core Technologies", - link: "/core-technologies", - items: [ - { text: "Zenroom", link: "/core-technologies#%F0%9F%94%90-zenroom" }, - { text: "Slangroom", link: "/core-technologies#📜-slangroom" }, - { text: "No-code-room", link: "/core-technologies#%F0%9F%9B%A0%EF%B8%8F-no-code-room-ncr" }, - { - text: "Dyne.org Decentralized Identifiers (DID) Service", - link: "/core-technologies#%F0%9F%94%97-dyne-org-decentralized-identifiers-did-service", - }, - ], - }, - { - text: "💡 The solution", - link: "/solution", - items: [ - { text: "DiDRoom Control Room (Dashboard)", link: "/solution#didroom-control-room-dashboard", }, - { text: "Didroom Microservices", link: "/solution#didroom-microservices" }, - { text: "Didroom Mobile Libs", link: "/solution#mobile-zencode" }, - { text: "Wallet holder app", link: "/solution#wallet-holder-app" }, - { text: "Verifier app", link: "/solution#verifier-app" }, - { text: "Didroom web components", link: "/solution#didroom-web-components" }, - ], - }, { - text: "🎮 Quickstart", - link: "/quickstart", + text: "Guide", items: [ - { text: "Software as a Service (SaaS)", link: "/quickstart"}, + { text: "System admins", link: "/guides/sysadmin/" }, + { text: "Organization admins", link: "/guides/orgadmin/" }, + { text: "Wallet holders", link: "/guides/wallet/" }, + { text: "Verifiers", link: "/guides/verifier/" }, ], }, - { - text: "🚀 Deployments", - items: [ - { text: "On-Premise deployment", link: "/on-premise" }, - { text: "Setup an issuance flows", link: "/dashboard/" }, - { text: "Deploy your microservices", link: "/microservices/" }, - ] - }, - { - text: "Security and compliance", - items: [ - { - text: "Overview of security measures", - link: "#overview-of-security-measures", - }, - { - text: "Compliance with Data Protection Regulations", - link: "#compliance-with-data-protection-regulations", - }, - { - text: "Best Practices for secure deployment", - link: "#best-practices-for-secure-deployment", - }, - ], - }, - { - text: "Integration and customization", - items: [ - { - text: "APIs and integration options", - link: "#apis-and-integration-options", - }, - { - text: "Customization capabilities", - link: "#customization-capabilities", - }, - { - text: "Extending Functionality with business login and 3rd party modules", - link: "#extending-functionality-with-plugins-and-modules", - }, - ], - }, - { - text: "Use Cases and Case Studies", - items: [ - { - text: "Industry-specific applications", - link: "#industry-specific-applications", - }, - { - text: "Success stories", - link: "#success-stories-and-testimonials", - }, - ], - }, - { - text: "Support and resources", - items: [ - { text: "Documentation", link: "#documentation" }, - { text: "Support channels", link: "#support-channels" }, - { - text: "Training and educational resources", - link: "#training-and-educational-resources", - }, - { text: "Contact Information", link: "#contact-information" }, - ], - }, - { - text: "🤟 Aknowledgements", - link: "/aknowledgements" - } + { text: "Get started", link: "/get_started" }, ], - + logo: "images/didroom_logo_emblem.svg", + sidebar: generateSidebar(vitepressSidebarOptions), socialLinks: [ { icon: "github", link: "https://github.com/forkbombeu/didroom" }, { icon: "linkedin", link: "https://linkedin.com/company/forkbomb" }, diff --git a/docs/.vitepress/theme/style.css b/docs/.vitepress/theme/style.css index d63aee8..0643e78 100644 --- a/docs/.vitepress/theme/style.css +++ b/docs/.vitepress/theme/style.css @@ -92,29 +92,29 @@ :root { --vp-home-hero-name-color: transparent; - --vp-home-hero-name-background: -webkit-linear-gradient( - 120deg, - #bd34fe 30%, - #41d1ff - ); - - --vp-home-hero-image-background-image: linear-gradient( - -45deg, - #bd34fe 50%, - #47caff 50% - ); - --vp-home-hero-image-filter: blur(44px); + /* --vp-home-hero-name-background: -webkit-linear-gradient( */ + /* 120deg, */ + /* #bd34fe 30%, */ + /* #41d1ff */ + /* ); */ + /**/ + /* --vp-home-hero-image-background-image: linear-gradient( */ + /* -45deg, */ + /* #bd34fe 50%, */ + /* #47caff 50% */ + /* ); */ + /* --vp-home-hero-image-filter: blur(44px); */ } @media (min-width: 640px) { :root { - --vp-home-hero-image-filter: blur(56px); + /* --vp-home-hero-image-filter: blur(56px); */ } } @media (min-width: 960px) { :root { - --vp-home-hero-image-filter: blur(68px); + /* --vp-home-hero-image-filter: blur(68px); */ } } diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 0000000..42c9e96 --- /dev/null +++ b/docs/404.md @@ -0,0 +1 @@ +🚫 Oops! Looks like the document you were hunting for is playing hide and seek with us! Don't worry, our crack team of digital detectives is on the case. 🕵️‍♂️🔍 While they're hot on the trail, feel free to kick back, grab a snack, and try your search again in a bit. We promise it'll turn up sooner than you can say "404!" 🕰️🔎 diff --git a/docs/aknowledgements.md b/docs/aknowledgements.md index 3049efb..cd45e2f 100644 --- a/docs/aknowledgements.md +++ b/docs/aknowledgements.md @@ -1,5 +1,5 @@ -# Aknowledgements +# 🫶🏻 Aknowledgements - + Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. diff --git a/docs/core-technologies.md b/docs/core-technologies.md index cf458d4..4641b8c 100644 --- a/docs/core-technologies.md +++ b/docs/core-technologies.md @@ -1,47 +1,51 @@ # 🏗️ Core Technologies -## 🔐 Zenroom - Zenroom is responsible for all underlying cryptographic operations within the Didroom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. +## 🔐 Zenroom - ::: tip RESOURCES +Zenroom is responsible for all underlying cryptographic operations within the Didroom ecosystem. It provides a secure execution environment for cryptographic operations and smart contracts, ensuring privacy, security, and integrity in digital interactions. Notably, Zenroom runs isomorphically on the web, mobile, and servers across various platforms in a deterministic way. - [Documentation](https://dev.zenroom.org/) - - [GitHub](https://github.com/dyne/zenroom) - - [Site](https://zenroom.org/) +::: tip RESOURCES - ::: +[Documentation](https://dev.zenroom.org/) + +[GitHub](https://github.com/dyne/zenroom) + +[Site](https://zenroom.org/) + +::: ## 📜 Slangroom - Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. - - ::: tip RESOURCES - [Documentation](https://dyne.org/slangroom) +Slangroom enhances the Zencode language of Zenroom by allowing the addition of plugins. These plugins extend the functionality of Zencode by enabling actions that do not necessarily need to be performed within virtual machines. Slangroom's approach is super standard, making it easy to add custom functionalities within the Zencode natural language. Additionally, Slangroom is capable of running over web pages using WebAssembly. + +::: tip RESOURCES - [GitHub](https://github.com/syne/slangroom) +[Documentation](https://dyne.org/slangroom) - ::: +[GitHub](https://github.com/syne/slangroom) + +::: ## 🛠️ No-code-room (NCR) - No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. - ::: tip RESOURCES - [GitHub](https://github.com/forkbombeu/ncr) +No-code-room is a Single Executable Application (SEA) for Linux. It takes a filesystem with .zen (Zencode/Slangroom) contracts and creates API microservices using live-directory routing. NCR seamlessly generates REST services that are auto-documented with OpenAPI. Additionally, it creates small graphic interfaces on the fly, referred to as applets. +::: tip RESOURCES + +[GitHub](https://github.com/forkbombeu/ncr) - ::: +::: ## 🔗 Dyne.org Decentralized Identifiers (DID) Service - In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. - ::: tip RESOURCES - [GitHub](https://github.com/dyne/w3c-did) +In 2022, Dyne.org implemented a W3C-DID method approved by the W3C governing board and included in the official DID method list. The DID service supports federation and provides tools for the creation, resolution, and management of decentralized identifiers (DIDs). It includes support for ECDSA, EDDSA, Schnorr, Ethereum address, as well as a Dilithium quantum-proof public key. +::: tip RESOURCES + +[GitHub](https://github.com/dyne/w3c-did) + +[Online DIDs Explorer](https://explorer.did.dyne.org/) - [Online DIDs Explorer](https://explorer.did.dyne.org/) - - [Specification](https://dyne.org/W3C-DID/) +[Specification](https://dyne.org/W3C-DID/) - [Site](https://forkbomb.solutions/component/w3c-did-federate-service/) +[Site](https://forkbomb.solutions/component/w3c-did-federate-service/) - ::: +::: diff --git a/docs/get_started.md b/docs/get_started.md new file mode 100644 index 0000000..42440ed --- /dev/null +++ b/docs/get_started.md @@ -0,0 +1,69 @@ +# 🏁 Get started + +Welcome to the Didroom Get Started guide! 🚀 We're thrilled to have you embark on this journey with us. Whether you're a seasoned **system administrator**, a savvy **organization administrator**, an enthusiastic **wallet holder**, or a meticulous **verifier**, this section is tailor-made to provide you with comprehensive, step-by-step instructions crafted specifically for your role within the Didroom ecosystem. + +:::info 💜 +We assume you're already familiar with Didroom's solution, its components and how they works. + +If it's not the case, please refer to the [introductory section](/intro.html) for an overview. +::: + +Below, you'll find detailed descriptions of each guide, carefully curated to empower you with the knowledge and tools you need to navigate the world of decentralized identity management 🔐 + +--- + +> [!CAUTION] System administrators +> For folks that wants to deploy and manage the infrastructure that powers Didroom. +> +> - [Setup an instance](/guides/sysadmin/setup) +> - [Self host the dashboard](/guides/sysadmin/setup_dashboard) +> - [Deploy microservices](/guides/sysadmin/deploy_microservices.md) + +> [!IMPORTANT] Organization administrators +> For folks that wants to oversee the configuration and management of decentralized identity solutions within their organizations. Here you'll find instructions on how to use the Dashboard to configure settings, monitor your issuance flows, and access key functionalities. +> +> - [Setup a credential issuer](/guides/orgadmin/credential_issuer.md) +> - [Setup an authorization server](/guides/orgadmin/auth_server.md) +> - [Create issuance flows](/guides/orgadmin/issuance_flow.md) +> - [Create verification flows](/404) +> - [Generate microservices from the dashboard](/404) +> - [Add custom business logic for credential issuing](/404) +> - [Add custom business logic for authorization](/404) +> - [Create an organization](/guides/orgadmin/create.md) + +> [!WARNING] Wallet holders +> +> For individuals that wants to use the Wallet Holder App to manage their decentralized identities and digital credentials securely. Here we walks you through the process of installing and using the Wallet Holder App to store, view, and share identity information with ease. +> +> - [Create an identity / keyring](/guides/wallet/register.md) +> - [Request a credential](/guides/wallet/get_credential.md) +> - [Present a credential](/guides/wallet/present_credential.md) +> - [Get part to an organization](/guides/wallet/join_org.md) +> - [Change language](/guides/wallet/change_language.md) +> - [Define preferences](/guides/wallet/preferences.md) +> - [Logout and wipe data](/guides/wallet/logout.md) + +> [!TIP] Verifiers +> +> For individuals that wants to utilize the Verifier App to verify the authenticity and validity of decentralized identities and digital credentials. Here we outlines how to install and use the Verifier App to validate identity claims and ensure compliance with regulatory requirements. +> +> - [Register as a verifier](/guides/verifier/register.md) +> - [Verify a credential](/guides/verifier/verify.md) +> - [Select a verification flow](/guides/verifier/verification_flow.md) +> - [Get part of an organization](/guides/verifier/join_org.md) + + diff --git a/docs/guides/concepts.md b/docs/guides/concepts.md new file mode 100644 index 0000000..2322912 --- /dev/null +++ b/docs/guides/concepts.md @@ -0,0 +1 @@ +# 📑 Concepts diff --git a/docs/guides/index.md b/docs/guides/index.md new file mode 100644 index 0000000..50a8673 --- /dev/null +++ b/docs/guides/index.md @@ -0,0 +1 @@ +# Guides diff --git a/docs/guides/orgadmin/auth_server.md b/docs/guides/orgadmin/auth_server.md new file mode 100644 index 0000000..d6d1270 --- /dev/null +++ b/docs/guides/orgadmin/auth_server.md @@ -0,0 +1,5 @@ +# Setup an authorization server metadata + +#### for 👩‍⚖️ Organization administrator + +