Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating read.me and docs for template #5

Merged
merged 4 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 0 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# API Reference

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it is obvious already so it is not needed but I originally left this to showcase the syntax

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when i left it, it caused an error when I ran mkdocs serve:
ERROR - Error reading page 'api.md': ERROR - Could not collect 'blueprint.hello'

i'll try re-add the example as a string to avoid the error

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ERROR - Error reading page 'api.md': ERROR - Could not collect 'blueprint.hello'

Right, I think it might be because the project itself was not installed.
You need to:

pip install -e .

From the root so mkdocs can import the blueprint module.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some changes needed in order to make the workflows work on this repo, I will open a PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@daavoo - okay do you want me to hold-off merging this? or can i go ahead and then you will do another PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is ok to merge this, I will open a different PR

::: blueprint.hello
7 changes: 7 additions & 0 deletions docs/assets/custom.css
Original file line number Diff line number Diff line change
@@ -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;
}
22 changes: 22 additions & 0 deletions docs/customization.md
Original file line number Diff line number Diff line change
@@ -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!
28 changes: 28 additions & 0 deletions docs/future-features-contributions.md
Original file line number Diff line number Diff line change
@@ -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 🎉
9 changes: 9 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Get started with this Blueprint using one of the options below:

---

### **Option 1:**



### **Option 2:**
Binary file added docs/images/Blueprints-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 39 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 0 additions & 3 deletions docs/requirements.txt

This file was deleted.

27 changes: 27 additions & 0 deletions docs/step-by-step-guide.md
Original file line number Diff line number Diff line change
@@ -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!
33 changes: 31 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Loading