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

Update name from "Redbox Copilot" to "Redbox" everywhere. #702

Merged
merged 2 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Code of Conduct - Redbox Copilot
# Code of Conduct - Redbox

## Our Pledge

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# 📮 Redbox Copilot
# 📮 Redbox

> [!IMPORTANT]
> Incubation Project: This project is an incubation project; as such, we DON’T recommend using it in any critical use case. This project is in active development and a work in progress. This project may one day Graduate, in which case this disclaimer will be removed.

> [!NOTE]
> The original streamlit-app has moved to its own repository https://github.com/i-dot-ai/redbox-copilot-streamlit.

Redbox Copilot is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts.
Redbox is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts.

- **Better retrieval**. Redbox Copilot increases organisational memory by indexing documents
- **Faster, accurate summarisation**. Redbox Copilot can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best
- **Better retrieval**. Redbox increases organisational memory by indexing documents
- **Faster, accurate summarisation**. Redbox can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best


https://github.com/i-dot-ai/redbox-copilot/assets/8233643/e7984242-1403-4c93-9e68-03b3f065b38d
Expand Down
2 changes: 1 addition & 1 deletion django_app/redbox_app/redbox_core/email_handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

EMAIL_MAPPING = {
"magic_link": {
"subject": "Redbox Copilot sign-in",
"subject": "Redbox sign-in",
"template_name": "email/verification.txt",
},
}
Expand Down
8 changes: 4 additions & 4 deletions django_app/redbox_app/templates/accessibility-statement.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
<div class="govuk-width-container iai-grid">
<div class="iai-grid__start-3-span-8">

<h1 class="govuk-heading-l">Accessibility statement for Redbox Copilot</h1>
<h1 class="govuk-heading-l">Accessibility statement for Redbox</h1>

<p class="govuk-body">This accessibility statement applies to Redbox Copilot.</p>
<p class="govuk-body">This accessibility statement applies to Redbox.</p>
<p class="govuk-body">This website is run by the Cabinet Office. We want as many people as possible to be able to use this website. For example, that means you should be able to:</p>
<ul class="govuk-list govuk-list--bullet">
<li>change colours, contrast levels and fonts</li>
Expand All @@ -27,10 +27,10 @@ <h2 class="govuk-heading-m">Feedback and contact information</h2>

<h2 class="govuk-heading-m">Reporting accessibility problems with this website</h2>
<p class="govuk-body">We're always looking to improve the accessibility of this website. If you find any problems not listed on this page or think we're not meeting accessibility requirements, contact the team at <a href="mailto:{{contact_email}}" class="govuk-link">{{contact_email}}</a>.</p>

<h2 class="govuk-heading-m">Enforcement procedure</h2>
<p class="govuk-body">The Equality and Human Rights Commission (EHRC) is responsible for enforcing the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018 (the "accessibility regulations"). If you're not happy with how we respond to your complaint, <a href="https://www.equalityadvisoryservice.com/" class="govuk-link">contact the Equality Advisory and Support Service (EASS)</a>.</p>

<h2 class="govuk-heading-m">Technical information about this website's accessibility</h2>
<p class="govuk-body">Cabinet Office is committed to making its website accessible, in accordance with the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018.</p>

Expand Down
2 changes: 1 addition & 1 deletion django_app/redbox_app/templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<head>
<meta charset="utf-8">
<title>{% if pageTitle %} {{ pageTitle }} - {% endif %}Redbox Copilot</title>
<title>{% if pageTitle %} {{ pageTitle }} - {% endif %}Redbox</title>
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
<meta name="theme-color" content="#0b0c0c">

Expand Down
6 changes: 3 additions & 3 deletions django_app/redbox_app/templates/privacy-notice.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<div class="govuk-width-container iai-grid">
<div class="iai-grid__start-3-span-8">

<h1 class="govuk-heading-l">Privacy notice for Redbox Copilot</h1>
<h1 class="govuk-heading-l">Privacy notice for Redbox</h1>
<div class="govuk-body">
<p class="govuk-body-l">This notice sets out how we will use your personal data, and your rights. It is made under Articles 13 and/or 14 of the UK General Data Protection Regulation (UK GDPR).</p>

Expand All @@ -34,11 +34,11 @@ <h3 class="govuk-heading-s">Legal basis of processing</h3>
</ul>

<h3 class="govuk-heading-s">Recipients</h3>
<p class="govuk-body">Your personal data will be shared by us with analysts/researchers within the Cabinet Office if you have consented to be contacted further about Redbox Copilot.</p>
<p class="govuk-body">Your personal data will be shared by us with analysts/researchers within the Cabinet Office if you have consented to be contacted further about Redbox.</p>
<p class="govuk-body">As your personal data will be stored on our IT infrastructure it will also be shared with our data processors who provide email, and document management and storage services.</p>

<h3 class="govuk-heading-s">Retention</h3>
<p class="govuk-body">Your personal data will be retained for 12 months after account inactivity. At that point we will delete your email address, depersonalising the data we hold. If you have provided us consent to contact you, we will retain your email until <DATE> and continue sharing it with evaluators so they can conduct research on the long term impact of Redbox Copilot.</p>
<p class="govuk-body">Your personal data will be retained for 12 months after account inactivity. At that point we will delete your email address, depersonalising the data we hold. If you have provided us consent to contact you, we will retain your email until <DATE> and continue sharing it with evaluators so they can conduct research on the long term impact of Redbox.</p>

<h3 class="govuk-heading-s">Your rights</h3>
<p class="govuk-body">You have the right to request information about how your personal data are processed, and to request a copy of that personal data.</p>
Expand Down
8 changes: 4 additions & 4 deletions django_app/redbox_app/templates/support.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ <h2 class="govuk-heading-m">User guide</h2>
<iframe src="https://player.vimeo.com/video/860937749?h=05caad19d6" class="video--iframe" frameborder="0" allowfullscreen title="<SYSTEM_NAME> support video"></iframe>
<p class="govuk-body">You can download the <a target="_blank" rel="noopener noreferrer" href="{{static('<USER_GUIDE_LOCATION>.pdf')}}" class="govuk-link"><SYSTEM_NAME> User Guide (PDF, 1.1MB)</a>, a step-by-step guide to signing in and using your <SYSTEM_NAME> account.</p>

<h2 class="govuk-heading-m">Accessing Redbox Copilot</h2>
<p class="govuk-body">You can access your Redbox Copilot account by visiting <a href="<SYSTEM_URL>" class="govuk-link"><SYSTEM_URL></a>. You'll need to type your work email address in the box provided and select the submit button.</p>
<h2 class="govuk-heading-m">Accessing Redbox</h2>
<p class="govuk-body">You can access your Redbox account by visiting <a href="<SYSTEM_URL>" class="govuk-link"><SYSTEM_URL></a>. You'll need to type your work email address in the box provided and select the submit button.</p>
#}

<h2 class="govuk-heading-m">Signing in</h2>
<p class="govuk-body">If you're having trouble signing in to the Redbox Copilot platform, check that:</p>
<p class="govuk-body">If you're having trouble signing in to the Redbox platform, check that:</p>

<ul class="govuk-list govuk-list--bullet">
<li>you're using your work email address</li>
<li>you've typed your work email address correctly</li>
</ul>

<p class="govuk-body">You should check your junk or spam folder for an email from Redbox Copilot.</p>
<p class="govuk-body">You should check your junk or spam folder for an email from Redbox.</p>

<p class="govuk-body">If you're still having trouble then you can contact us using the details at the bottom of this page.</p>

Expand Down
24 changes: 12 additions & 12 deletions django_app/tests_playwright/pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def __init__(self, page):
super().__init__(page)

def get_expected_page_title(self) -> str:
return "Redbox Copilot"
return "Redbox"

def navigate_to_sign_in(self) -> "SignInPage":
self.page.get_by_role("link", name="Sign in", exact=True).click()
Expand All @@ -109,7 +109,7 @@ def navigate_to_sign_in(self) -> "SignInPage":

class SignInPage(BasePage):
def get_expected_page_title(self) -> str:
return "Sign in - Redbox Copilot"
return "Sign in - Redbox"

@property
def email(self) -> str:
Expand All @@ -126,7 +126,7 @@ def continue_(self) -> "SignInLinkSentPage":

class SignInLinkSentPage(BasePage):
def get_expected_page_title(self) -> str:
return "Sign in - link sent - Redbox Copilot"
return "Sign in - link sent - Redbox"


class SignInConfirmationPage(BasePage):
Expand All @@ -135,7 +135,7 @@ def __init__(self, page, magic_link: URL):
super().__init__(page)

def get_expected_page_title(self) -> str:
return "Sign in - confirmation - Redbox Copilot"
return "Sign in - confirmation - Redbox"

def navigate_to_documents_page(self) -> "DocumentsPage":
self.page.get_by_role("button", name="Start", exact=True).click()
Expand All @@ -144,7 +144,7 @@ def navigate_to_documents_page(self) -> "DocumentsPage":

class HomePage(SignedInBasePage):
def get_expected_page_title(self) -> str:
return "Redbox Copilot"
return "Redbox"


class DocumentRow(NamedTuple):
Expand All @@ -154,7 +154,7 @@ class DocumentRow(NamedTuple):

class DocumentsPage(SignedInBasePage):
def get_expected_page_title(self) -> str:
return "Documents - Redbox Copilot"
return "Documents - Redbox"

def delete_latest_document(self) -> "DocumentDeletePage":
self.page.get_by_role("button", name="Remove").first.click()
Expand All @@ -171,7 +171,7 @@ def get_all_document_rows(self) -> list[DocumentRow]:

class DocumentDeletePage(SignedInBasePage):
def get_expected_page_title(self) -> str:
return "Remove document - Redbox Copilot"
return "Remove document - Redbox"

def confirm_deletion(self) -> "DocumentsPage":
self.page.get_by_role("button", name="Remove").click()
Expand All @@ -180,7 +180,7 @@ def confirm_deletion(self) -> "DocumentsPage":

class DocumentUploadPage(SignedInBasePage):
def get_expected_page_title(self) -> str:
return "Upload a document - Redbox Copilot"
return "Upload a document - Redbox"

def upload_document(self, upload_file: Path) -> DocumentsPage:
self.get_file_chooser_by_label().set_files(upload_file)
Expand All @@ -200,7 +200,7 @@ class FeedbackType(Enum):

class ChatsPage(SignedInBasePage):
def get_expected_page_title(self) -> str:
return "Chats - Redbox Copilot"
return "Chats - Redbox"

@property
def write_message(self) -> str:
Expand Down Expand Up @@ -228,17 +228,17 @@ def give_feedback(self, feedback: FeedbackType):

class PrivacyPage(BasePage):
def get_expected_page_title(self) -> str:
return "Privacy notice - Redbox Copilot"
return "Privacy notice - Redbox"


class AccessibilityPage(BasePage):
def get_expected_page_title(self) -> str:
return "Accessibility statement - Redbox Copilot"
return "Accessibility statement - Redbox"


class SupportPage(BasePage):
def get_expected_page_title(self) -> str:
return "Support - Redbox Copilot"
return "Support - Redbox"


def batched(iterable, n):
Expand Down
10 changes: 5 additions & 5 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Redbox Copilot
# Contributing to Redbox

First off, thanks for taking the time to contribute! ❤️

Expand All @@ -13,7 +13,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
<!-- omit in toc -->
## Table of Contents

- [Contributing to Redbox Copilot](#contributing-to-redbox-copilot)
- [Contributing to Redbox](#contributing-to-redbox-copilot)
- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
Expand All @@ -29,7 +29,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
## Code of Conduct

This project and everyone participating in it is governed by the
[Redbox Copilot Code of Conduct](https://github.com/i-dot-ai/redbox-copilot/blob/main/CODE_OF_CONDUCT.md).
[Redbox Code of Conduct](https://github.com/i-dot-ai/redbox-copilot/blob/main/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior
to [email protected]

Expand Down Expand Up @@ -92,7 +92,7 @@ Once it's filed:

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Redbox Copilot, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion for Redbox, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

#### Before Submitting an Enhancement

Expand All @@ -110,7 +110,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/i-dot-
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
- **Explain why this enhancement would be useful** to most Redbox Copilot users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- **Explain why this enhancement would be useful** to most Redbox users. You may also want to point out the other projects that solved it better and which could serve as inspiration.


## Styleguides
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Welcome to Redbox

Redbox Copilot is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts.
Redbox is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts.

- **Better retrieval**. Redbox Copilot increases organisational memory by indexing documents
- **Faster, accurate summarisation**. Redbox Copilot can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best
- **Better retrieval**. Redbox increases organisational memory by indexing documents
- **Faster, accurate summarisation**. Redbox can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best

!!! info "Version"
This documentation is for Redbox version:
Expand Down
28 changes: 14 additions & 14 deletions tests/pages.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def __init__(self, page, base_url: URL):

@property
def expected_page_title(self) -> str:
return "Redbox Copilot"
return "Redbox"

def navigate_to_sign_in(self) -> "SignInPage":
self.page.get_by_role("link", name="Sign in", exact=True).click()
Expand All @@ -123,7 +123,7 @@ def navigate_to_sign_in(self) -> "SignInPage":
class SignInPage(BasePage):
@property
def expected_page_title(self) -> str:
return "Sign in - Redbox Copilot"
return "Sign in - Redbox"

@property
def email(self) -> str:
Expand All @@ -141,11 +141,11 @@ def continue_(self) -> "SignInLinkSentPage":
class SignInLinkSentPage(BasePage):
@property
def expected_page_title(self) -> str:
return "Sign in - link sent - Redbox Copilot"
return "Sign in - link sent - Redbox"


class SignInConfirmationPage(BasePage):
EXPECTED_TITLE = "Sign in - confirmation - Redbox Copilot"
EXPECTED_TITLE = "Sign in - confirmation - Redbox"

def __init__(self, page, magic_link: URL):
page.goto(str(magic_link))
Expand Down Expand Up @@ -174,13 +174,13 @@ def _where_are_we(page: Page) -> Union["DocumentsPage", "MyDetailsPage"]:
class HomePage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Redbox Copilot"
return "Redbox"


class MyDetailsPage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "My details - Redbox Copilot"
return "My details - Redbox"

@property
def grade(self) -> str:
Expand Down Expand Up @@ -220,7 +220,7 @@ class DocumentRow:
class DocumentsPage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Documents - Redbox Copilot"
return "Documents - Redbox"

def navigate_to_upload(self) -> "DocumentUploadPage":
self.page.get_by_role("button", name="Add document").click()
Expand Down Expand Up @@ -259,7 +259,7 @@ def wait_for_documents_to_complete(self, retry_interval: int = 5, max_tries: int
class DocumentUploadPage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Upload a document - Redbox Copilot"
return "Upload a document - Redbox"

def upload_documents(self, upload_files: Sequence[Path]) -> DocumentsPage:
self.get_file_chooser_by_label().set_files(upload_files)
Expand All @@ -275,7 +275,7 @@ def get_file_chooser_by_label(self):
class DocumentDeletePage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Remove document - Redbox Copilot"
return "Remove document - Redbox"

def confirm_deletion(self) -> "DocumentsPage":
self.page.get_by_role("button", name="Remove").click()
Expand All @@ -300,7 +300,7 @@ def navigate_to_citations(self) -> "CitationsPage":
class ChatsPage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Chats - Redbox Copilot"
return "Chats - Redbox"

@property
def write_message(self) -> str:
Expand Down Expand Up @@ -372,7 +372,7 @@ def wait_for_latest_message(self, role="Redbox") -> ChatMessage:
class CitationsPage(SignedInBasePage):
@property
def expected_page_title(self) -> str:
return "Citations - Redbox Copilot"
return "Citations - Redbox"

def back_to_chat(self) -> ChatsPage:
self.page.get_by_role("link", name="Back to chat", exact=True).click()
Expand All @@ -382,16 +382,16 @@ def back_to_chat(self) -> ChatsPage:
class PrivacyPage(BasePage):
@property
def expected_page_title(self) -> str:
return "Privacy notice - Redbox Copilot"
return "Privacy notice - Redbox"


class AccessibilityPage(BasePage):
@property
def expected_page_title(self) -> str:
return "Accessibility statement - Redbox Copilot"
return "Accessibility statement - Redbox"


class SupportPage(BasePage):
@property
def expected_page_title(self) -> str:
return "Support - Redbox Copilot"
return "Support - Redbox"
Loading