Update name

mozilla-ai · Jan 17, 2025 · aac554b · aac554b
1 parent 7dacb5b
commit aac554b
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -1,29 +1,29 @@
 <p align="center"><img src="./images/Blueprints-logo.png" width="35%" alt="Project logo"/></p>
 
-# Structured-Q&A: a Blueprint by Mozilla.ai for answering questions about structured documents.
+# Structured-QA: a Blueprint by Mozilla.ai for answering questions about structured documents.
 
 
 [![](https://dcbadge.limes.pink/api/server/YuMNeuKStr?style=flat)](https://discord.gg/YuMNeuKStr)
-[![Docs](https://github.com/mozilla-ai/structured-q-a/actions/workflows/docs.yaml/badge.svg)](https://github.com/mozilla-ai/structured-q-a/actions/workflows/docs.yaml/)
-[![Tests](https://github.com/mozilla-ai/structured-q-a/actions/workflows/tests.yaml/badge.svg)](https://github.com/mozilla-ai/structured-q-a/actions/workflows/tests.yaml/)
-[![Ruff](https://github.com/mozilla-ai/structured-q-a/actions/workflows/lint.yaml/badge.svg?label=Ruff)](https://github.com/mozilla-ai/structured-q-a/actions/workflows/lint.yaml/)
+[![Docs](https://github.com/mozilla-ai/structured-qa/actions/workflows/docs.yaml/badge.svg)](https://github.com/mozilla-ai/structured-qa/actions/workflows/docs.yaml/)
+[![Tests](https://github.com/mozilla-ai/structured-qa/actions/workflows/tests.yaml/badge.svg)](https://github.com/mozilla-ai/structured-qa/actions/workflows/tests.yaml/)
+[![Ruff](https://github.com/mozilla-ai/structured-qa/actions/workflows/lint.yaml/badge.svg?label=Ruff)](https://github.com/mozilla-ai/structured-qa/actions/workflows/lint.yaml/)
 
 
 This Blueprint demonstrates how to use open-source models and a simple LLM workflow to answer questions based on structured documents.
 
 It is designed to showcase a simpler alternative to more complex and/or resource demanding alternatives, such as RAG systems that rely on vectorDBs and/or long-context models with large token windows.
 
 
-### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/structured-q-a/).
+### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/structured-qa/).
 
 
 ## Quick-start
 
-Get started with structured-q-a using one of the options below:
+Get started with structured-qa using one of the options below:
 
 | Google Colab | HuggingFace Spaces  | GitHub Codespaces |
 | -------------| ------------------- | ----------------- |
-| [![Try on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/mozilla-ai/structured-q-a/blob/main/demo/notebook.ipynb) | [![Try on Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Try%20on-Spaces-blue)](https://huggingface.co/spaces/mozilla-ai/structured-q-a) | [![Try on Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=888426876&skip_quickstart=true&machine=standardLinux32gb) |
+| [![Try on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/mozilla-ai/structured-qa/blob/main/demo/notebook.ipynb) | [![Try on Spaces](https://img.shields.io/badge/%F0%9F%A4%97%20Try%20on-Spaces-blue)](https://huggingface.co/spaces/mozilla-ai/structured-qa) | [![Try on Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=888426876&skip_quickstart=true&machine=standardLinux32gb) |
 
 Alternatively, you can install it from pypi:
 

diff --git a/demo/app.py b/demo/app.py
@@ -24,7 +24,7 @@ def convert_to_sections(uploaded_file, output_dir):
     )
 
 
-st.title("Structured Q&A")
+st.title("Structured QA")
 
 st.header("Uploading Data")
 

diff --git a/demo/notebook.ipynb b/demo/notebook.ipynb
@@ -11,14 +11,14 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Source code: https://github.com/mozilla-ai/structured-q-a"
+    "Source code: https://github.com/mozilla-ai/structured-qa"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Docs: https://mozilla-ai.github.io/structured-q-a"
+    "Docs: https://mozilla-ai.github.io/structured-qa"
    ]
   },
   {

diff --git a/docs/future-features-contributions.md b/docs/future-features-contributions.md
@@ -7,18 +7,18 @@ This Blueprint is an evolving project designed to grow with the help of the open
 ## 🌟 **How You Can Contribute**
 
 ### 🛠️ **Enhance the Blueprint**
-- Check the [Issues](https://github.com/mozilla-ai/structured-q-a/issues) page to see if there are feature requests you'd like to implement
-- Refer to our [Contribution Guide](https://github.com/mozilla-ai/structured-q-a/blob/main/CONTRIBUTING.md) for more details on contributions
+- Check the [Issues](https://github.com/mozilla-ai/structured-qa/issues) page to see if there are feature requests you'd like to implement
+- Refer to our [Contribution Guide](https://github.com/mozilla-ai/structured-qa/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/structured-q-a/blob/main/CONTRIBUTING.md) to get started!
+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/structured-qa/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 Issues](https://github.com/mozilla-ai/structured-q-a/issues).
+Got an idea for how this Blueprint could be improved? You can share your suggestions through [GitHub Issues](https://github.com/mozilla-ai/structured-qa/issues).
 
 ### 🌍 **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.

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,4 +1,4 @@
-Get started with Structured-Q-A using one of the options below:
+Get started with Structured-QA using one of the options below:
 
 ---
 
@@ -29,7 +29,7 @@ Get started with Structured-Q-A using one of the options below:
       You can install the project from Pypi:
 
       ```bash
-      pip install structured-q-a
+      pip install structured-qa
       ```
 
       Check the [Command Line Interface](./cli.md) guide.
@@ -41,8 +41,8 @@ Get started with Structured-Q-A using one of the options below:
       1. **Clone the Repository**
 
          ```bash
-         git clone https://github.com/mozilla-ai/structured-q-a.git
-         cd structured-q-a
+         git clone https://github.com/mozilla-ai/structured-qa.git
+         cd structured-qa
          ```
 
       2. **Install the project and its Dependencies**

diff --git a/docs/index.md b/docs/index.md
@@ -1,12 +1,12 @@
-# **Structured-Q-A Blueprint**
+# **Structured-QA Blueprint**
 
 <div style="text-align: center;">
   <img src="images/document-to-podcast-diagram.png" alt="Project Logo" style="width: 100%; margin-bottom: 1px; margin-top: 1px;">
 </div>
 
 Blueprints empower developers to easily integrate AI capabilities into their projects using open-source models and tools.
 
-These docs are your companion to mastering the **Structured-Q-A Blueprint** a local-first approach for answering questions about your structured documents.
+These docs are your companion to mastering the **Structured-QA Blueprint** a local-first approach for answering questions about your structured documents.
 
 ### Built with
 - Python 3.10+
@@ -15,7 +15,7 @@ These docs are your companion to mastering the **Structured-Q-A Blueprint** a lo
 ---
 
 ### 🚀 **Get Started Quickly**
-#### _Start building your own Structured-Q-A pipeline in minutes:_
+#### _Start building your own Structured-QA pipeline in minutes:_
 - **[Getting Started](getting-started.md):** Quick setup and installation instructions.
 
 ### 🔍 **Understand the System**

diff --git a/docs/step-by-step-guide.md b/docs/step-by-step-guide.md
@@ -1,4 +1,4 @@
-# **Step-by-Step Guide: How the Structured-Q-A Blueprint Works**
+# **Step-by-Step Guide: How the Structured-QA Blueprint Works**
 
 ## **Overview**
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,6 @@
-site_name: Blueprints Docs
-repo_url: https://github.com/mozilla-ai/structured-q-a
-repo_name: structured-q-a
+site_name: Structured QA
+repo_url: https://github.com/mozilla-ai/structured-qa
+repo_name: structured-qa
 
 nav:
   - Home: index.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -24,7 +24,7 @@ def convert_to_sections(uploaded_file, output_dir): @@
         )
-    st.title("Structured Q&A")
+    st.title("Structured QA")
     st.header("Uploading Data")
@@ Expand Down @@