From 9f4a625a432ebfbceec057879ed7c52e99205eee Mon Sep 17 00:00:00 2001
From: stefanfrench <stefrfr@gmail.com>
Date: Tue, 10 Dec 2024 11:07:20 +0000
Subject: [PATCH 1/4] updating read.me and docs for template

---
 README.md                             |  33 +++++++++++++--------
 docs/api.md                           |   1 -
 docs/assets/custom.css                |   7 +++++
 docs/customization.md                 |  22 ++++++++++++++
 docs/future-features-contributions.md |  28 ++++++++++++++++++
 docs/getting-started.md               |  10 +++++++
 docs/images/Blueprints-logo.png       | Bin 0 -> 7489 bytes
 docs/index.md                         |  40 +++++++++++++++++++++++++-
 docs/requirements.txt                 |   3 --
 docs/step-by-step-guide.md            |  27 +++++++++++++++++
 mkdocs.yml                            |  31 ++++++++++++++++++--
 11 files changed, 182 insertions(+), 20 deletions(-)
 create mode 100644 docs/assets/custom.css
 create mode 100644 docs/customization.md
 create mode 100644 docs/future-features-contributions.md
 create mode 100644 docs/getting-started.md
 create mode 100644 docs/images/Blueprints-logo.png
 delete mode 100644 docs/requirements.txt
 create mode 100644 docs/step-by-step-guide.md

diff --git a/README.md b/README.md
index abc2d3a..9d11b53 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,19 @@
-<img src="./images/Blueprints-logo.png" alt="Project Logo" style="width:25%;">
-
-# Blueprint Title
+<p align="center"><img src="./images/Blueprints-logo.png" width="35%" alt="Project logo"/></p>
 
 This blueprint guides you to ...
 
-![Blueprint Diagram](./images/blueprint-diagram.png)
+### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/Blueprint-template/)
+
+### Built with
+- Python 3.10+
+- Open-Source Tool 1
+- Open-Source Tool 2
+- ...
+
+## Quick-start
+
+
+## How it Works
 
 
 ## Pre-requisites
@@ -12,20 +21,20 @@ This blueprint guides you to ...
 - **System requirements**:
   - OS: Windows, macOS, or Linux
   - Python 3.10 or higher
-  - Minimum RAM: 4 GB
-  - Disk space: 1 GB minimum
+  - Minimum RAM: 
+  - Disk space: 
 
 - **Dependencies**:
-  - Dependencies listed in `requirements.txt`
-
-## Installation
+  - Dependencies listed in `pyproject.toml`
 
----
 
-## Quick-start
+## Troubleshooting
 
----
 
 ## License
 
 This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! To get started, you can check out the [CONTRIBUTING.md](CONTRIBUTING.md) file.
\ No newline at end of file
diff --git a/docs/api.md b/docs/api.md
index cbf15b4..ecbc0fb 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -1,3 +1,2 @@
 # API Reference
 
-::: blueprint.hello
diff --git a/docs/assets/custom.css b/docs/assets/custom.css
new file mode 100644
index 0000000..c3dc2ff
--- /dev/null
+++ b/docs/assets/custom.css
@@ -0,0 +1,7 @@
+@import url('https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&display=swap');
+
+:root {
+    --md-default-font: "Inter", sans-serif;
+    --md-code-font: "Fira Code", monospace;
+    --md-primary-font: "Inter", sans-serif;
+}
diff --git a/docs/customization.md b/docs/customization.md
new file mode 100644
index 0000000..20db5f3
--- /dev/null
+++ b/docs/customization.md
@@ -0,0 +1,22 @@
+# 🎨 **Customization Guide**
+
+This Blueprint is designed to be flexible and easily adaptable to your specific needs. This guide will walk you through some key areas you can customize to make the Blueprint your own.
+
+---
+
+## 🧠 **Changing the Model**
+
+
+
+## 📝 **Modifying the system Prompt**
+
+
+
+## 💡 Other Customization Ideas
+
+- other ideas..
+
+
+## 🤝 **Contributing to the Blueprint**
+
+Want to help improve or extend this Blueprint? Check out the **[Future Features & Contributions Guide](future-features-contributions.md)** to see how you can contribute your ideas, code, or feedback to make this Blueprint even better!
diff --git a/docs/future-features-contributions.md b/docs/future-features-contributions.md
new file mode 100644
index 0000000..e8ae92d
--- /dev/null
+++ b/docs/future-features-contributions.md
@@ -0,0 +1,28 @@
+# 🚀 **Future Features & Contributions**
+
+This Blueprint is an evolving project designed to grow with the help of the open-source community. Whether you’re an experienced developer or just starting, there are many ways you can contribute and help shape the future of this tool.
+
+---
+
+## 🌟 **How You Can Contribute**
+
+### 🛠️ **Enhance the Blueprint**
+- Check the [Issues](https://github.com/mozilla-ai/blueprint-template/issues) page to see if there are feature requests you'd like to implement
+- Refer to our [Contribution Guide](https://github.com/mozilla-ai/blueprint-template/blob/main/CONTRIBUTING.md) for more details on contributions
+
+### 🎨 **Extensibility Ideas**
+
+This Blueprint is designed to be a foundation you can build upon. By extending its capabilities, you can open the door to new applications, improve user experience, and adapt the Blueprint to address other use cases. Here are a few ideas for how you can expand its potential:
+
+
+We’d love to see how you can enhance this Blueprint! If you create improvements or extend its capabilities, consider contributing them back to the project so others in the community can benefit from your work. Check out our [Contributions Guide](https://github.com/mozilla-ai/blueprint-template/blob/main/CONTRIBUTING.md) to get started!
+
+### 💡 **Share Your Ideas**
+Got an idea for how this Blueprint could be improved? You can share your suggestions through [GitHub Discussions](https://github.com/mozilla-ai/blueprint-template/discussions).
+
+### 🌍 **Build New Blueprints**
+This project is part of a larger initiative to create a collection of reusable starter code solutions that use open-source AI tools. If you’re inspired to create your own Blueprint, you can use the [Blueprint-template](https://github.com/new?template_name=Blueprint-template&template_owner=mozilla-ai) to get started.
+
+---
+
+Your contributions help make this Blueprint better for everyone 🎉
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..0395d15
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,10 @@
+Get started with this Blueprint using one of the options below: 
+
+---
+
+### **Option 1:**
+
+
+
+###  **Option 2:**
+
diff --git a/docs/images/Blueprints-logo.png b/docs/images/Blueprints-logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..b865f869e3ec73014a17f929a658a90e100dac57
GIT binary patch
literal 7489
zcmeHsg<Di>yFRIaD4`%A5>nDFHFU^O1JWSv5CTJYgMgCKf~1t>NaFxAqLiqJG{S&%
zNp}o$*6h8%Z|~pl`~l}WG1s+bz4bizQ}4Cjb*~q?IuEatF_7Wm;avx-t31NP!%qO(
z9VAzP|3XKNBVa(^Nm*GJtgOtU>*;3i<O0RRyPx9o^1TM3&8=uu*K=M+8&+E?J$Kf)
zBz!x1HUVp@g!!SqC-oYcHmR+k@Vutzj0epRA`_#1k0RqBg-xkypZu{Z+Hd^l+~se?
zepw11E`4p^Ph27z;2aRz(}Ap8g9VmFGo_^2qx-Tit=+-*g167OXBKqNVFqZkoy6RH
zXPX6UnXX@YHY;vOm>JuTT-I~tMPV&oiX_&#U$7a2cCKmYXZ??{aSJqZdW^L@s!|R0
zjFd>4Eivjql@mQQ`S{5$gHAbF&p5^U`H`c&cuBCHAgfr}E9)H7<?M5=4Som0C&H7x
z_rSSC0n;bl!eA;IOZKQvIwqS$j}&8{i?+7Pth;!#*CbmiEvxU;o)xi~9-bwYA|+a1
zyh4;>#n$g5JnO(UA6>Hs{hv(1od?CpORr9aq8c}c=*2*tKD#&7X|3j0hHkO}Q8t2_
zfbF%l@pynX2_Al|6CM%J!Urw};KIWrOpU?23f!rIOQn$DU$giLg@pfV<8|N`D(WkP
z!N6VL&JzlSc{#dy3!d@i0IJ5E3{1RDw6&z|+*}20p19dU1^ivzaUysie`%oU3iY;O
z@ppBBc}e@r-uq*PG|<Kk3*KY-V~Mx3>^&20T^40GPbkX+0U-gQdvatfEG!_;C-%~h
zRMh?w2YRyi9KF5Wr3D53{QLy`L<QVD9R!7?q@)CeL<B`d_<<GtUI8#~8-IS77u%mo
z{-s9+>SgEY<nHa{24lhLwXt>c@s_=J4+r$`-=B6u{hj_sf_eSr7T};DZbnd8KuGZ4
zx&cuTZd6*=$sg)ss^a7dga^Qo6PA<${jvT(&HRn{4@r~1B}Jtk{8REDGylJ&p%>Is
z+07Mz^p^WOGk*#HbMh}ikRZ<Ue?;QXF#j<M#959EB>3-~$&nq9o9y7>(L=#1iU$7p
zn|VQB?{){o#`a?;be;)I8tl@L33GOLU-=T@*{k~OnOMxoNMtJq5w*GtX@3)c%Omj#
zN&|f1?vg?RnvX<|)a8=ag$g_h0xx62m2>f8bTjCpif^44Xlz~H__`LlGBx={s%@p+
z0qIZzS&?aL5ZwlC=bvsq_G_^KyAzQp;1N)UE8s`Wa!Y=9`l}a@7ulJJhmY%(k|glb
zI4h()Ky{3MGYvJBIetB0x;$XvZE!Aw#mUn76676D6URe5t1|O#>rEPkv=GF_EP(U`
zTe$VaJ}Iptuu2Gw*D16{n-Gad#A2O{7isgI%Y+C3_`r@&^r^&Lhzu|yT$X?&Mz+A3
ziU^QSBcdcvgLU4=*>FU{LU$A#sY)4+N2Eoq@V^4!1FS7ocdVKj+4|X{>8K4_e9XAr
zBIAoF=r}c!$s;U-_%P=QAu)MjxJZ-BL<|JN*7MWQy~jDzEw*>Xyb$L5OT(H=614`^
z6l|Ei%^KJOFY2u)xW;36UeEa>`xRX9Ng`UBJ2nm+ga<jGKX@npNC-=W27iJqr;htm
zfkROf!=IrdEP^Bo*1suViG{Ymp6IPTMssQ1zuq!Lr?zI`9M>wfM)11fqCV#l8~q=-
zB7OYsguUhI8aL<lQqBJVOYQ%}>i-}a#5wuSvGX@(Iz#iamCDXCB&h0qcf$>FyQO{Y
z0dg;X8pN5%yuF3oX`hz7T)dl%?L%XW9WcgnY#i<%4l1_J<gvrnYnP#DHrS_Y@}&7I
zL_`RVaBHHzZ?EdhWp)dtA{u0wbV}Q#sFG30W2;CSOc&{b=G5*4MB>nqE{lRNBAIsj
zW}rKZLLn)EH&|S;Nh#-iTechBHt*81R_4}P5u{V=&Y{N&?2dyhyvQF`Go91yjNh%o
zGW7ij@d@f~>Sk?YYcWU9QToXybU}5o$Y7Ef*4tZB9+5#i^Kh9&b4nIU(Fj4N5dW{;
z@y#v?Hbjrlhcd0+$8QG|h8(rd7Tjdi^gkNq-@0@taPGa15#^?Oc6$DmysUU*Wawn*
zMK9tG)5W-v$oBTcnoiqpvu|oIqvTXx+v?jRzsraZ@2GUgHv*<VeOhkL>>yG5;3^-q
z&tH!6Cb=FdpG6V_|24d;jNQ1}FjpCGHvf`lCG~sWgpS+!Kwj~cE~*5+r*<n7%Mvr5
zu@<4O?><PoN#**El=Hogb(JEbOkkAM&I@#&YJ*LF!>;BdmxsRcjfj`Z&Aj1m$-eC+
z6i5*GoNhU2;rBvP!py@uTFOqkmkx(f<LPETiqPmNdmZL=4c02HB0GkLQ*;Ms8)P7N
z*|$KbQ#<FRlWySX*bgDm4D&(-I!wJCv%Fs;oupaaJv&v$QK#rj?!|%TzkO<trPp^}
zsB@f|{v|tGlX!_33@O>4iG3OZb|*zsDF`7JjJ_D6E)HcnnZH*jZ%%qK<y4w;@}V&K
zL)SVEqEKs^nxbhPTjvyQQ_P{D{l{a9C`r#wq-dU*VSwWNSzr9?>HhO^sir}tx!Qfy
z`VH-&FV{32x^rY6s^~$z>_vRNordnx)vG?J4*1RO*L&6*m7xPaWiCj_z|8a>G1$D`
zO1qjLGGpPrN6MBIi{wMBBOVlk!b;%~tKtP{K(%(y))?r(L<U9WWIxTDCNCm<7utob
z`Yw&eY&sP%duUm0Y3{YoZ*3<?*AmVQ2=alt`1y9)APRO#64gNyvJFmNWoS93f?`q@
zy5j7E%|2%^@#3TSlOcMDMt)<^^`bFN2Si)giOOsMXrpaDX6O*IXgXe+48Fg0ac0`-
zJ>-GG_Unf+@L6=seJ*tWonoNQdLC?689uCNr{OGkW@Zyz><u>$jFaJ7dt}<azWmh)
zB5~@>(`4VfG|Ar_urj;^#ulu=z1t74hW;0Z_ugry_9OJ&(=A8aIYvxv^A62-lvu+I
zu2a+2gbWcXjK=0x26WRFI5nxsB0_p^6lWgVkDbOto+hHb^-oW8IT&)pbbE7X3_%)I
zzlSSaUT#7zzHu}y!u#K=^98>@KMdFia4=eCjp5OhkK8-$%(&g$)s}U!*eh-&hqegm
zxg7|$*RqJWCLcuS*xw<WnoWiXvD2bKRQAG^RYP*vk?-Dzi?v)fFVx@}iyY;l%~cl-
zuSPty;#ZU!@b`zZ<k`hAB!<MuKF+38%EWsb%()MR`aPbqXCefZ<|?wnn54zid%uI`
zCLY-q!3eM|H40*ePRI3wdKn!&@vx}9?b1|(%ds)GCyA`-OKe4Yes*b!6nCl1-~8HU
zO*CG`z9~E}bef8Hp^Mp1up#f$tmIRIcp^GCUZsfcPsdM{p7)n0dxcFZFHPvYjSn*z
zi}$+X!a>f9YMDXj3%{y{mBT~MPJY>{8Zxa#CpkPu{dD@I77h6}i5fM&D`L7r(`6nq
zDIdHgKNVHDUODu;5c)Z8vE4^-uPDDCBhU%mn`NV75H{VL3w(C?nWg;!`H1b0S<Y+X
z4Ux3&Gv|w<oBGh6$G1*@tc1=F9Y^F3H1JGIiIz3_ujT%JAGqmf5vZn@!rX4dB`Db%
zvhBNEBN=c!CpCMyl1UM4cBv0NR!pN->O9|#D9@)C=T^J~UA}x@qj*@o$E&@mgPC+j
z(re@|km3{BDYSGpeaR&9Lh@(7(0{1@os;3oZDY%p_|QdD!ZPHA8R$JI`^SM&{oVGn
z*MM!(fptI9!Sb$;^lcg<c>*@=O58O?!b49jj+@}SyBM>pq{mI4zgFw2R-HI71*w<|
z^)JGAQ~6t}pF&FwFDzYxXNn+J0(oKZ!o#Iu^{ItqXh<!}MRntyuSB2Ovvtf)O)Qg-
zJZ5>+6x^8PlsQhrod2y~W?Sw;TLhMcbdVAKkpQn&^yubABtMClbhbC>%R)vQ^nNlc
z->eHR*Q~q(Ipb236{p3lIeDX(!sarWd>!ovDnHbRzROOD{Z*L%dk<l;*LBYVq&<#l
zE1^lHF?f;d`Q&i)Q{@wOwY4}&-VoHF$VP6`X&k4wocH4lFVi}bQoR+A-TR1RcE&Y+
zFX?@_NI>EK&o|p%4%*k$^sWg*TrQ$jk)XW~kdwE;_LPOuDfp%9tcI7Y`1fCDBA^0o
zE1en}bp2(reg5lLNQiwx(oa*)H{4pWS36-%`m_V^uR7bT+;<K}xPv%um@3j}k8%xr
z-_|$E!N?h9#{Ra<5Y02B&^Ej<Yt9WwQyG!wzO#2xBD)Z$(%>Q|+@maXWz|rS8amT1
zp&%O6f3|;ZnHWB9+sLEHAE8@X6Zg0#`^}h=wESV6F)4!s38~s>oLW?!wn3#~|1iC=
z-F;}}ZzE@RG1|i0p!dILK8Sqwqgh#fqCdb>BVM!gnQYsTGQWDmPCf?M$e*?^zn^Cm
z#9eiS8Jlju7A;m)G8G45e`Z>j)@-Ua`?=83Ygp0v(s<}euVZfz*BHU6`;!z6zzyTA
zSd5N8afrju?d61`Mxx^VNCqV8a^oFY#gsl=R-kQIVMPPW@b%73Fbf@_cSAFH(7(qE
z%yBZJDKFR|+l!}No8FXv5`We>8luPXyZ=RX$6IMXx*Mw7WgiEesT>(gHH;HxHemb)
zRD-aSL$jGTSIM>G29LOZ);>Y^FekrS8g-s|jK#+%Dvps+w9tIYpH8}F-_Aqt<I#wa
zO3jv26_xETapO+PKiOAuY?*0yUYBm^C_z;&N<6Q9#dCB$=y9U#qEB>1@L7nHcC?jM
zab}67{7%;wcw-rVR!AY8uaWj-vh|3<(M&nkZp7X<;Pcb6bXxV&ZspxW3%HZ)SzJbG
zLHhn4{lWV(1gFx{kWLF!*)mIGQcQZ`u&q7sG&y=Z08ZS;gEDJ9+ZR1NaBmT&qD*{P
zcWO;rcVVYh^=)Oi&-D6$lXL}aW}wjMp<q>(%<vt}*)OoriCby(`hl}Ht=v<#VB;Ec
z{+*2nCq^9)m`BWB-T7`hwtpmm{wb0$&PqqPmvi=MoRdGTx-e5sVuP%HXr7M9maQ<t
zwZ?Kh;k{*)858vlS1G0YoC;Y6!o@wd7v@87hM&Ikt&jl$*@a?Z!aF*WZulk=rWAqL
zn!)}(SpP@yQ=)?prLLexY+AFMX?g;&ukY@1xzJwqgYFCMy^po^4b^Ivvc5<F{h$dp
zs4H1AFZNAWIts+}^Y-Vd#g_e@+0$nVh6L+x_O9(V&Su#6-%YFj{0ciap_*}ktn=P|
zj_Im=EMqi(4^ZGevp!;(pLxZkgv#{xw~cYm2*WbZB=z=Q!L+oxHwfhvg|R&5wM6zp
zdR<^2oQTz!-%)=`gQPWzp|v<O5JMJyqf&M|-rw!n<Fcc(n>@Ej@95WJf1x<`0r}nc
zWkcN2XH(tP&5a8_GtrOf-*jxFFtz898Vc9LqAlLUptpC#w(~F27B?fF3E`X3**vgY
z{`!@yA*gadW$0GVU>bVPOHR+}>|H+H{!!T;BooTmVs$%mcQ@CEBWD}pm>KR{b-hE!
zWUBpElacrq>+Yb5vEy}Ja{hD9j&N%+a0|;Oa1NvBS#=;53mZ!)yqm{0(g>$+v@%c^
zs)W(K72wm3{Yo}(s46sqDa6;G#pY$$uha>0MpYFRcH2C&C%u>yj=d^zYOqnHF4XR0
z7`z3a+b0AL%GY;vbff9X;G^w6U6~)+Sktl0-(=r4d06$)hCQ|rDe9l?UAq|3e4(W1
zMB}qx0zVW4X)y0&{q$`%qNSiwzd`)(I68(-EbD2Ai%bcUQ3o1AQSD<^J8u$h2A~b;
zfAmhX0?!eFabC@Rp4qDsNZl%EfK1A|llgYD0NDyVVWeRc0)KD$%f>g4^`|^!mGAZ~
znGw<fb&ye(OX$k%MzryKI!&WRcg*d|&EVG=H+uI-7dJT!RWF)`mF~a2mO;rGZvAX>
zBvg&27@>IZ@pOv7EqOnCc{5>s!QgZx++}7s?P!LyCNKkC9{?6%dFxuVPsH+tvtvv2
zR-@~u;i_84j%6|4q&=h3T7G>c%$NG|_3#G7JMX;Z+1P&mphb8X>S)i}`1$<EVT?+t
zD#=Y<<43DAX(zKjm&RV^)rhQv!sfH;-x3l$4x2GrBsZ<e*}j$?(AUr&292g8?{mGe
z_gwwlzU97A47p;ZP|_YOWsrS_RzG~8h+3%bQkqiQAmy*}DKRe151CGJZCK$$RUe{4
zR|Cy0SM%nn2@<tkG(-E=xIjxaooj<>9p6`ZtG0KrnU{|}(Ji?%G?@PNjO-;NrJwcf
z_uZNVsyj$3#Gb|6t8MdE4H6wVPtCLYqN8u9nm-z+RbCXETpa{a-4zr`d+R9iYrF+H
z%rjTb9VCU;<YKpgt6sJr7WFc`p?+9T5+f{MSr1!Jw3>ySO)6*jGDO{eejtoNi3GIx
zSPmu&A4H8z?HwRjbbo3XkH_#t=_1i_8@cquW@vTZo2>h8$zK}y(@`^z#-Fvu?%j!5
zSUb0V6n&j_c)avWwvI9d^D(>m`eMgiy$=Nke^O=9R8YlJxlfD*0^G_#zJ55=B9X%J
z7ipmq^lzho@%F$FU&NwRA&1mmh{(`i=(wta{EE@#rySll)59{dP0@=~Q{p}@v-KCu
zmlb2@>IrUOv+w8`&AQY3a1e<aQ=VMj@I)jJGrs_jjQBhA;St$F=7$-BPY>DoiJ0TA
z)Q7YWKrD`9vn+?#^VdPfOKtvnz6-9hm=BnrH+L<8!}RoS9^X_TRaNytPrtBiqc`th
zeoAoJ)vC(lI+PryA_&|zD*!>5k#+;GTDEG5U4x00w9&A!$rXzs{Uzg31&pM@T*m2K
zCA5gyq5Nf@2WGuC>>V}#x7YBqsN;`3mK}1F5Df$>crg6*;u@T%TUk!#_n!0lx}ci_
zU%}6xR%ne5B6Kn$c_|(?q%o`MB55*nvu#sD>2wv7SV8uUBKJsQ<;Qy`Gl#og9Zj<@
zFN2Q<R&)1~7bkbEKFefRl~kFsnMq-;Hk7rUo?l>PD#Wed9<#~sjEELLdowIuT7(I#
zkId(ck3?CXW4>zAQf{TRH;=_0r?$*H?N~HBYCy9OE}G6p$jb-gEak%slD6Se0iB&}
z{(VWeEyIeNlv?AiBVF<WR)Y+!e9DRvkCe=-7ANm>7QOVdSP>66Enis95KV?miUos8
zeOB?$+uk>nB_fh<J(LUPrzaW@>TG+T6)cB2X=ll%S?wJ?OR>rTQ6}&-K9?~dLQo|X
z@v!u$fj`t+4|32f@jooW@mnJhyw0};+}uh4llVLpFOsU%ock8Q5=NW>FIb179I80x
zNe^HK-+1#z<0wX5dHm)p6@UZ-Yaw@Dj@)aSe1EBSLtmrdB!G_@V5OTT{y{yMbIUbT
z9pDt#S%GJqEF+j0$AlgLSzWcz!pAWOBgz17EL#PR=X{<I;C94wv*2(80Y>uBot*}U
z`{O2n>nBY742Mer94nZTN(caUjU|wPMD0MJEF4E$uCs<)k9<loz<Hwrc=LRw`xYe*
zP8NU*luRYVX<Y@p`O)@@0O#i0SiDF*iieLP0Iig=_(W`hxAhfpaEFu%LhEztJUFdy
zxWcVfwr$Bs0JuUX0Per16GF8bq%9q&Pp-i}ni-mbap&t(=0S-3cw7p|??mvMx4b_T
zgss1x4ARQ|MY|=_U=WJi4;8P#C8Kxpy?Mu`O&>__;zFzNK{A54;n)je<>kc9yOzom
z{X!iVD3)+*cM4n<!xgv*G7u#Xxa`Q159-`DJMPL%XZVGcTf78lpw%Qfci;bq)_xP<
zg<hd$1SnM}a=SH~*vx+TP~q`q5X9qb!}z5_De=N96+Rppj;iNk#$_k*=4$oI@<7h=
zfT-E`9~`46n+jKO2FwE%bj>}~z{h3E1IX0E^Ur^n!wBSG@<N>(XT6vXUZ*3YFg?!D
z=TShp#WHgf;|ik(D2zllPC^`l2ax~y9kx=OSA&v3xp{Ow!FkSd1JKGCT5<~q#{d+D
zSkfzUoYpQypxizsrxW13UjX2GsM7FpS|x!Z_Bcs-goAU;1voNETM?XA%Bw)R-H?Ao
z_NPM%LJSYJ{%f2Ns@-J_?6cl`$cX^bGofQs&{5uqUHK!@!j!m3f6K9HHUWwu(sV<J
s9B>ei=qqKRW`6>&5E0M|cO}4H)gm*x+WBP?hWl^^R@G6dRkDu!58ga6iU0rr

literal 0
HcmV?d00001

diff --git a/docs/index.md b/docs/index.md
index e3018ee..627b3ef 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1 +1,39 @@
-# Wellcome to Blueprint docs
+# **Welcome to the Blueprint docs**
+
+Blueprints are customizable workflows that help developers build AI applications using open-source tools and models
+
+These docs are your companion to mastering this Blueprint.
+
+### Built with
+- Python 3.10+
+- Tool 1
+- Tool 2
+
+
+---
+
+### 🚀 **Get Started Quickly**
+#### _Start building the Blueprint in minutes:_
+- **[Getting Started](getting-started.md):** Quick setup and installation instructions.
+
+### 🔍 **Understand the System**
+#### _Dive deeper into how the Blueprint works:_
+- **[Step-by-Step Guide](step-by-step-guide.md):** A detailed breakdown of the system’s design and workflow.
+- **[API Reference](api.md):** Explore the technical details of the core modules.
+
+### 🎨 **Make It Yours**
+#### _Customize the Blueprint to fit your needs:_
+- **[Customization Guide](customization.md):** Tailor project parameters to fit your needs
+
+### 🌟 **Join the Community**
+#### _Help shape the future of Blueprints:_
+- **[Future Features & Contributions](future-features-contributions.md):** Learn about exciting upcoming features and how to contribute to the project.
+
+
+Have more questions? Reach out to us on [GitHub Discussions](https://github.com/mozilla-ai/blueprint-template/discussions).
+
+---
+
+## **Why Blueprints?**
+
+Blueprints are more than starter code—they’re your gateway to building AI-powered solutions with confidence. With step-by-step guidance, modular design, and open-source tools, we make AI accessible for developers of all skill levels.
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index c584e19..0000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-mkdocs
-mkdocs-material
-mkdocstrings[python]
diff --git a/docs/step-by-step-guide.md b/docs/step-by-step-guide.md
new file mode 100644
index 0000000..ac117ca
--- /dev/null
+++ b/docs/step-by-step-guide.md
@@ -0,0 +1,27 @@
+# **Step-by-Step Guide: How this Blueprint Works**
+
+
+---
+
+## **Overview**
+
+
+---
+
+## **Step 1**
+
+
+## **Step 2**
+
+
+## **Step 3**
+
+
+
+## 🎨 **Customizing the Blueprint**
+
+To better understand how you can tailor this Blueprint to suit your specific needs, please visit the **[Customization Guide](customization.md)**.
+
+## 🤝 **Contributing to the Blueprint**
+
+Want to help improve or extend this Blueprint? Check out the **[Future Features & Contributions Guide](future-features-contributions.md)** to see how you can contribute your ideas, code, or feedback to make this Blueprint even better!
diff --git a/mkdocs.yml b/mkdocs.yml
index cbf0a8d..22c5241 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,17 +1,42 @@
-site_name: Blueprint Docs
+site_name: Blueprints Docs
 
 nav:
   - Home: index.md
+  - Getting Started: getting-started.md
+  - Step-by-Step Guide: step-by-step-guide.md
+  - Customization Guide: customization.md
   - API Reference: api.md
+  - Future Features & Contributions: future-features-contributions.md
 
 theme:
   name: material
   palette:
-    primary: deep orange
+    - scheme: default
+      primary: "#005F6F"
+      toggle:
+        icon: material/lightbulb
+        name: Switch to dark mode
+    - scheme: slate
+      primary: "#005F6F"
+      toggle:
+        icon: material/lightbulb-outline
+        name: Switch to light mode
+  extra_css:
+    - assets/custom.css
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
 
 plugins:
+- search
 - mkdocstrings:
     handlers:
       python:
         options:
-          show_root_heading: true
+          show_root_heading: true
\ No newline at end of file

From 1baa7a9c12e6fbd2b8a78cadce602af31319358e Mon Sep 17 00:00:00 2001
From: stefanfrench <stefrfr@gmail.com>
Date: Tue, 10 Dec 2024 11:13:57 +0000
Subject: [PATCH 2/4] pre-commit checks

---
 README.md               | 6 +++---
 docs/api.md             | 1 -
 docs/getting-started.md | 3 +--
 mkdocs.yml              | 2 +-
 4 files changed, 5 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 9d11b53..1cb3f13 100644
--- a/README.md
+++ b/README.md
@@ -21,8 +21,8 @@ This blueprint guides you to ...
 - **System requirements**:
   - OS: Windows, macOS, or Linux
   - Python 3.10 or higher
-  - Minimum RAM: 
-  - Disk space: 
+  - Minimum RAM:
+  - Disk space:
 
 - **Dependencies**:
   - Dependencies listed in `pyproject.toml`
@@ -37,4 +37,4 @@ This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE
 
 ## Contributing
 
-Contributions are welcome! To get started, you can check out the [CONTRIBUTING.md](CONTRIBUTING.md) file.
\ No newline at end of file
+Contributions are welcome! To get started, you can check out the [CONTRIBUTING.md](CONTRIBUTING.md) file.
diff --git a/docs/api.md b/docs/api.md
index ecbc0fb..b0d5c88 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -1,2 +1 @@
 # API Reference
-
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 0395d15..7ba8a0c 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -1,4 +1,4 @@
-Get started with this Blueprint using one of the options below: 
+Get started with this Blueprint using one of the options below:
 
 ---
 
@@ -7,4 +7,3 @@ Get started with this Blueprint using one of the options below:
 
 
 ###  **Option 2:**
-
diff --git a/mkdocs.yml b/mkdocs.yml
index 22c5241..78e501d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -39,4 +39,4 @@ plugins:
     handlers:
       python:
         options:
-          show_root_heading: true
\ No newline at end of file
+          show_root_heading: true

From 0fa82b38a4e06a617897f6ba6fd5d6c9958d6252 Mon Sep 17 00:00:00 2001
From: stefanfrench <stefrfr@gmail.com>
Date: Tue, 10 Dec 2024 11:28:09 +0000
Subject: [PATCH 3/4] update to mkdocs.yml

---
 mkdocs.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mkdocs.yml b/mkdocs.yml
index 78e501d..c1cbccb 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,4 +1,6 @@
 site_name: Blueprints Docs
+repo_url: https://github.com/mozilla-ai/blueprint-template
+repo_name: blueprint-template
 
 nav:
   - Home: index.md
@@ -9,6 +11,8 @@ nav:
   - Future Features & Contributions: future-features-contributions.md
 
 theme:
+  icon:
+    repo: fontawesome/brands/github
   name: material
   palette:
     - scheme: default

From 2f8c73fd1c7f37b8eb2df5e01437d59db8fe226e Mon Sep 17 00:00:00 2001
From: stefanfrench <stefrfr@gmail.com>
Date: Tue, 10 Dec 2024 12:05:09 +0000
Subject: [PATCH 4/4] minor change to api.md

---
 docs/api.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/api.md b/docs/api.md
index b0d5c88..104ec01 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -1 +1,3 @@
 # API Reference
+
+"::: blueprint.hello"