updating read.me and docs for template (#5)

* updating read.me and docs for template

* pre-commit checks

* update to mkdocs.yml

* minor change to api.md

README.md

@@ -1,31 +1,40 @@
-<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
 
 - **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.

docs/api.md

@@ -1,3 +1,3 @@
 # API Reference
 
-::: blueprint.hello
+"::: blueprint.hello"

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;
+}

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!

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 🎉

docs/getting-started.md

@@ -0,0 +1,9 @@
+Get started with this Blueprint using one of the options below:
+
+---
+
+### **Option 1:**
+
+
+
+###  **Option 2:**

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.

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!

mkdocs.yml

@@ -1,15 +1,44 @@
-site_name: Blueprint Docs
+site_name: Blueprints Docs
+repo_url: https://github.com/mozilla-ai/blueprint-template
+repo_name: blueprint-template
 
 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:
+  icon:
+    repo: fontawesome/brands/github
   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: