Merge pull request #671 from alan-turing-institute/README-updates

update README

README.md

@@ -2,7 +2,6 @@
 
 ![An illustration representing the collaborative development of a structured assurance case. The image shows various groups of people working together across different workstations linked by different paths.](site/docs/assets/images/hero.gif)
 
-[![All Contributors](https://img.shields.io/github/all-contributors/alan-turing-institute/AssurancePlatform?color=ee8449&style=flat-square)](#contributors)
 [![Go to the TEA Platform](https://img.shields.io/badge/Go%20to%20the%20TEA%20Platform-0F76B8?style=flat&link=https://assuranceplatform.azurewebsites.net/)](https://assuranceplatform.azurewebsites.net/)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8198986.svg)](https://doi.org/10.5281/zenodo.8198986)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/alan-turing-institute/AssurancePlatform/main.svg)](https://results.pre-commit.ci/latest/github/alan-turing-institute/AssurancePlatform/main)
@@ -19,53 +18,27 @@ and [University of York](https://www.york.ac.uk/assuring-autonomy/).
 
 The UK's Responsible Technology Adoption Unit (Department of Science, Innovation, and Technology) is also a project partner.
 
-To use the TEA platform, please go to [https://assuranceplatform.azurewebsites.net/](https://assuranceplatform.azurewebsites.net/).
+## Usage and Deployment Instructions 💻
 
-> [!WARNING]
-> The TEA platform is made available as a research preview, and should not be used for any business critical tasks. Future breaking changes should be expected.
-
-To view the documentation site, please go to
-[https://alan-turing-institute.github.io/AssurancePlatform](https://alan-turing-institute.github.io/AssurancePlatform).
+### 1 Use the TEA Platorm
 
-## What is Trustworthy and Ethical Assurance? 🤝
+If you'd like to just use the TEA platform, and have some familiarity with building assurance cases already, please go to [https://assuranceplatform.azurewebsites.net/](https://assuranceplatform.azurewebsites.net/).
 
-> Trustworthy and ethical assurance is a methodology and procedure for
-> developing a structured argument, which provides reviewable (and contestable)
-> assurance that a set of claims about a normative goal of a data-driven
-> technology are warranted given the available evidence.
-
-The following elements are central to this methodology and procedure:
-
-- **The SAFE-D Principles**: a set of five operationalisable
-  principles—Sustainability, Accountability, Fairness, Explainability, Data
-  Stewardship—that have been carefully designed and refined to address
-  real-world challenges associated with the design, development, and deployment
-  of data-driven technologies.
-- **Assurance Cases**: the documented argument that communicates the basis for
-  how and why a goal has been achieved.
-- **Argument Patterns**: starting templates for building assurance cases. They
-  identify the types of claims (or, the sets of reasons) that need to be
-  established to justify the associated top-level normative goal.
+> [!WARNING]
+> The TEA platform is made available as a **research preview**, and should not be used for any business critical tasks. Future breaking changes should be expected.
 
-The Trustworthy and Ethical Assurance platform brings these elements together in
-a usable and accessible manner, and helps project teams to provide trustworthy
-and justifiable assurance about the processes they undertook when designing,
-developing, and deploying their technology or system.
+### 2 Learn About TEA
 
-## Installation Instructions 💻
+If you are not sure what an assurance case is, or need some help using the platform, please view our documentation site at
+[https://alan-turing-institute.github.io/AssurancePlatform](https://alan-turing-institute.github.io/AssurancePlatform).
 
-To get started quickly with installing this platform visit the [backend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/backend/installation/) and [frontend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/frontend/installation/) installation instructions.
+### 3 Run Locally
 
-The Trustworthy and Ethical Assurance application can be run locally or deployed
-on your own server or a cloud-based service (e.g. Azure). To view the different
-installation instructions, please visit our documentation site for the
-[backend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/backend/installation/)
-and [frontend](https://alan-turing-institute.github.io/AssurancePlatform/platform-details/frontend/installation/).
+The TEA application can be run locally or deployed on your own server or a cloud-based service (e.g. Azure). You can find the instructions on how to do this here: [https://alan-turing-institute.github.io/AssurancePlatform/technical-documentation/local-quickstart/](https://alan-turing-institute.github.io/AssurancePlatform/technical-documentation/local-quickstart/)
 
 ## Further Resources 📚
 
-The following resources provide additional information about the Trustworthy and
-Ethical Assurance framework and methodology:
+The following resources provide additional information about the Trustworthy and Ethical Assurance framework and methodology:
 
 - Burr, C., Arana, S., Gould Van Praag, C., Habli, I., Kaas, M., Katell, M., Laher, S., Leslie, D., Niederer, S., Ozturk, B., Polo, N., Porter, Z., Ryan, P., Sharan, M., Solis Lemus, J. A., Strocchi, M., Westerling, K., (2024) Trustworthy and Ethical Assurance of Digital Health and Healthcare. [https://doi.org/10.5281/zenodo.10532573](https://doi.org/10.5281/zenodo.10532573)
 - Porter, Z., Habli, I., McDermid, J. et al. A principles-based ethics assurance argument pattern for AI and autonomous systems. AI Ethics 4, 593–616 (2024). [https://doi.org/10.1007/s43681-023-00297-2](https://doi.org/10.1007/s43681-023-00297-2)
@@ -80,14 +53,3 @@ Between April 2023 and December 2023, this project received funding from the Ass
 
 Between July 2021 and June 2022 this project received funding from the UKRI’s Trustworthy Autonomous Hub, which was awarded to Dr Christopher Burr
 (Grant number: TAS_PP_00040).
-
-## Contributors
-
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->

next_frontend/components/cases/NodeAttributes.tsx

@@ -102,8 +102,8 @@ const NodeAttributes: React.FC<NodeAttributesProps> = ({
 
       <div className='mt-4 flex justify-start items-center gap-2'>
         {!node.data.assumption && (
-          <Button 
-            variant={'outline'} 
+          <Button
+            variant={'outline'}
             size={'sm'}
             onClick={() => setNewAssumption(!newAssumption)}
           >
@@ -112,8 +112,8 @@ const NodeAttributes: React.FC<NodeAttributesProps> = ({
           </Button>
         )}
         {!node.data.justification && node.type === 'strategy' && (
-          <Button 
-            variant={'outline'} 
+          <Button
+            variant={'outline'}
             size={'sm'}
             onClick={() => setNewJustification(!newJustification)}
           >
@@ -122,7 +122,7 @@ const NodeAttributes: React.FC<NodeAttributesProps> = ({
           </Button>
         )}
       </div>
-      
+
       <Form {...form}>
         <form onSubmit={form.handleSubmit(onSubmit)} className="space-y-6 my-4">
           {(node.data.assumption || newAssumption) && (

next_frontend/tea-docs/components/card.js

@@ -1,15 +1,19 @@
-import { FileTextIcon } from "lucide-react"
+import { FileTextIcon } from "lucide-react";
 
 export const CardComponent = ({ title, description, url }) => {
   return (
-    <a href={url} style={{ textDecoration: 'none' }}>
+    <a href={url} style={{ textDecoration: "none" }}>
       <div className="bg-gray-100/50 dark:bg-slate-900 p-6 rounded-lg group hover:bg-indigo-500 dark:hover:bg-indigo-600 hover:cursor-pointer transition-all duration-300">
         <div className="flex justify-start items-center gap-2 mb-2">
-          <FileTextIcon className="size-5 group-hover:text-white transition-all duration-300"/>
-          <div className="text-xl font-semibold group-hover:text-white transition-all duration-300">{title}</div>
+          <FileTextIcon className="size-5 group-hover:text-white transition-all duration-300" />
+          <div className="text-xl font-semibold group-hover:text-white transition-all duration-300">
+            {title}
+          </div>
+        </div>
+        <div className="text-muted-foreground text-sm group-hover:text-white transition-all duration-300">
+          {description}
         </div>
-        <div className="text-muted-foreground text-sm group-hover:text-white transition-all duration-300">{description}</div>
       </div>
     </a>
-  )
-}
+  );
+};

next_frontend/tea-docs/components/cardList.js

@@ -1,8 +1,3 @@
-
 export const CardList = ({ children }) => {
-  return (
-    <div className="grid grid-cols-2 gap-6">
-      {children}
-    </div>
-  )
-}
+  return <div className="grid grid-cols-2 gap-6">{children}</div>;
+};