Merge pull request #46 from COS301-SE-2024/feature/main_readMe

Updated the main readMe and a few others
COS301-SE-2024 · Jun 2, 2024 · f140e99 · f140e99
2 parents 85b1b18 + ce01737
commit f140e99
Show file tree

Hide file tree

Showing 16 changed files with 203 additions and 201 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,19 @@
 # The Republic: COS 301 Capstone Project 2024
 
-<img src="./documentation/images/InfiniteLoopers_21.jpeg" width="100%" height="50%" style="display: block; margin: 15px auto; border-radius: 30px; background-color: #d1d1d1;">
+<img src="./documentation/images/image.png" width="100%" height="50%" style="display: block; margin: 15px auto; border-radius: 30px; background-color: #d1d1d1;">
 
 > The Republic project aims to revolutionize citizen engagement with government services by providing a platform for individuals to share their experiences, report incidents, and voice their concerns. This initiative is designed to enhance transparency and accountability within government operations, allowing users to contribute to a public discourse that promotes improved service delivery. By organizing and analyzing user-generated content, The Republic seeks to provide a clear and comprehensive picture of government service performance, fostering a more informed and active citizenry.
 
 <div align="center">
 
-  ![last Push](https://img.shields.io/github/last-commit/COS301-SE-2024/The-Republic)
-  ![GitHub issues](https://img.shields.io/github/issues/COS301-SE-2024/The-Republic)
-  [![Issues closed](https://img.shields.io/github/issues-closed/COS301-SE-2024/The-Republic?color=blue)](https://github.com/COS301-SE-2024/The-Republic/issues?q=is%3Aissue+is%3Aclosed)
-  ![Languages](https://img.shields.io/github/languages/count/COS301-SE-2024/The-Republic)
-  ![GitHub pull requests](https://img.shields.io/github/issues-pr/COS301-SE-2024/The-Republic)
-  ![Backend Linter](https://img.shields.io/github/workflow/status/COS301-SE-2024/The-Republic/linter-backend)
-  ![Frontend Linter](https://img.shields.io/github/workflow/status/COS301-SE-2024/The-Republic/linter-frontend)
-  ![Codecov](https://codecov.io/gh/COS301-SE-2024/The-Republic/branch/main/graph/badge.svg)
+![last Push](https://img.shields.io/github/last-commit/COS301-SE-2024/The-Republic)
+![GitHub issues](https://img.shields.io/github/issues/COS301-SE-2024/The-Republic)
+[![Issues closed](https://img.shields.io/github/issues-closed/COS301-SE-2024/The-Republic?color=blue)](https://github.com/COS301-SE-2024/The-Republic/issues?q=is%3Aissue+is%3Aclosed)
+![Languages](https://img.shields.io/github/languages/count/COS301-SE-2024/The-Republic)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/COS301-SE-2024/The-Republic)
+![Backend Linter](https://img.shields.io/github/workflow/status/COS301-SE-2024/The-Republic/linter-backend)
+![Frontend Linter](https://img.shields.io/github/workflow/status/COS301-SE-2024/The-Republic/linter-frontend)
+![Codecov](https://codecov.io/gh/COS301-SE-2024/The-Republic/branch/main/graph/badge.svg)
 
 </div>
 
@@ -22,15 +22,16 @@
 The documentation will guide you through various aspects of the project, including architectural design, implementation details, and user guidelines. [View Full Documentation Here](./documentation/README.md)
 
 #### `Links to Specific Sections of the Documentation`:
+
 - [Link to Coding Standards](./documentation/specifications/CodingStandards.md)
-- [Link to User Manual](./documentation/specifications/UserManual.md)
+<!-- - [Link to User Manual](./documentation/specifications/UserManual.md) -->
 - [Link to Requirements Specification](./documentation/specifications/RequirementsSpecification.md)
-- [Link to Implementation Specification](./documentation/specifications/ImplementationSpecification.md)
+<!-- -[Link to Implementation Specification](./documentation/specifications/ImplementationSpecification.md) -->
 - [Link to Delivery Specification](./documentation/specifications/DeliverySpecification.md)
-- [Link to Testing Specification](./documentation/specifications/TestingSpecification.md)
+<!-- -[Link to Testing Specification](./documentation/specifications/TestingSpecification.md)
 - [Link to Project Plan](./documentation/specifications/ProjectPlan.md)
 - [Link to Design Specification](./documentation/specifications/DesignSpecification.md)
-- [Link to Architectural Specification](./documentation/specifications/ArchitecturalSpecification.md)
+- [Link to Architectural Specification](./documentation/specifications/ArchitecturalSpecification.md) -->
 
 <p align="center">
   <img src="./documentation/images/assets/il_logo_lighter.png" width="150" height="auto">
@@ -45,7 +46,7 @@ The documentation will guide you through various aspects of the project, includi
     </td>
     <td style="vertical-align: top; width: auto; border: 0; padding: 10px;">
       <h2>
-        <b style="font-size: 18px;">Team Manager: SHAMA KAMINA</b>
+        <b style="font-size: 18px;">SHAMA KAMINA</b>
       </h2>
       <b style="font-size: 16px;">UI/UX Designer & Frontend Developer</b>
       <br> As a UI/UX designer, I am committed to enhancing user experiences and making life easier through thoughtful design. I focus on identifying user problems and creating intuitive solutions using my skills in both design and front-end development. My work aims to bridge the gap between functionality and aesthetics, ensuring that the products I design are both effective and enjoyable to use.
@@ -58,9 +59,6 @@ The documentation will guide you through various aspects of the project, includi
       <a href="https://www.linkedin.com/in/shama-k-257386153" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
         <img src="https://skillicons.dev/icons?i=linkedin">
       </a>
-      <a href="#" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
-        <img src="https://skillicons.dev/icons?i=twitter">
-      </a>
       <br><br>
       <b style="font-size: 16px;">Technologies & Tools Used</b>
       <br><br>
@@ -103,9 +101,6 @@ The documentation will guide you through various aspects of the project, includi
       <a href="https://www.linkedin.com/in/mulisa-musehane-96119b233" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
         <img src="https://skillicons.dev/icons?i=linkedin">
       </a>
-      <a href="#" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
-        <img src="https://skillicons.dev/icons?i=twitter">
-      </a>
       <br><br>
       <b style="font-size: 16px;">Technologies & Tools Used</b>
       <br><br>
@@ -148,9 +143,6 @@ The documentation will guide you through various aspects of the project, includi
       <a href="https://www.linkedin.com/in/sibisi-mathebe" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
         <img src="https://skillicons.dev/icons?i=linkedin">
       </a>
-      <a href="#" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
-        <img src="https://skillicons.dev/icons?i=twitter">
-      </a>
       <br><br>
       <b style="font-size: 16px;">Technologies & Tools Used</b>
       <br><br>
@@ -193,9 +185,6 @@ The documentation will guide you through various aspects of the project, includi
       <a href="https://www.linkedin.com/in/sello-selepe-tebogoyungmercykay" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
         <img src="https://skillicons.dev/icons?i=linkedin">
       </a>
-      <a href="#" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
-        <img src="https://skillicons.dev/icons?i=twitter">
-      </a>
       <br><br>
       <b style="font-size: 16px;">Technologies & Tools Used</b>
       <br><br>
@@ -238,9 +227,6 @@ The documentation will guide you through various aspects of the project, includi
       <a href="http://www.linkedin.com/in/hlokomani" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
         <img src="https://skillicons.dev/icons?i=linkedin">
       </a>
-      <a href="#" style="text-decoration: none; margin-right: 10px; display: inline-block; vertical-align: middle;">
-        <img src="https://skillicons.dev/icons?i=twitter">
-      </a>
       <br><br>
       <b style="font-size: 16px;">Technologies & Tools Used</b>
       <br><br>
@@ -266,15 +252,8 @@ The documentation will guide you through various aspects of the project, includi
   </tr>
 </table>
 
-
 ---
 
-Feel free to contact us at: [infiniteloopers@gmail.com](mailto:infiniteloopers@gmail.com)
-
-<details>
-    <summary> :lock: Secret Message</summary>
-    <br/>
-    <p>Thank you for opening this, Have a great day! :smile:</p>
-</details>
+Feel free to contact us at: [inifiniteloopers@gmail.com](mailto:inifiniteloopers@gmail.com)
 
 ---
diff --git a/documentation/README.md b/documentation/README.md
@@ -8,16 +8,15 @@
 
 ## Table of Contents
 
-1. [Main README](../README.md)
-2. [Architectural Specification](#architectural-specification)
-3. [Design Specification](#design-specification)
-4. [Project Plan](#project-plan)
-5. [Testing Specification](#testing-specification)
-6. [Delivery Specification](#delivery-specification)
-7. [Implementation Specification](#implementation-specification)
-8. [Requirements Specification](#requirements-specification)
-9. [User Manual](#user-manual)
-10. [Coding Standards](#coding-standards)
+1. [Architectural Specification](#architectural-specification)
+2. [Design Specification](#design-specification)
+3. [Project Plan](#project-plan)
+4. [Testing Specification](#testing-specification)
+5. [Delivery Specification](#delivery-specification)
+6. [Implementation Specification](#implementation-specification)
+7. [Requirements Specification](#requirements-specification)
+8. [User Manual](#user-manual)
+9. [Coding Standards](#coding-standards)
 
 ---
 
@@ -95,12 +94,6 @@ This document outlines the coding standards and best practices to be followed du
 
 [Link to Coding Standards](./specifications/CodingStandards.md)
 
-Feel free to contact us at: [infiniteloopers@gmail.com](mailto:infiniteloopers@gmail.com)
-
-<details>
-    <summary> :lock: Secret Message</summary>
-    <br/>
-    <p>Thank you for opening this, Have a great day! :smile:</p>
-</details>
+[Go back](/README.md)
 
 ---
diff --git a/documentation/images/InfiniteLoopers_21.jpeg b/documentation/images/InfiniteLoopers_21.jpeg
diff --git a/documentation/images/gifs/Delivery.gif b/documentation/images/gifs/Delivery.gif
diff --git a/documentation/images/gifs/FunctionalRequirements.gif b/documentation/images/gifs/FunctionalRequirements.gif
diff --git a/documentation/images/gifs/Testing.gif b/documentation/images/gifs/Testing.gif
diff --git a/documentation/images/image.png b/documentation/images/image.png
diff --git a/documentation/specifications/ArchitecturalSpecification.md b/documentation/specifications/ArchitecturalSpecification.md
@@ -23,13 +23,6 @@ The Republic is a platform aimed at revolutionizing citizen engagement with gove
 ---
 
 [Back to Full Documentation](./../README.md)
+[Back to main](/README.md)
 
-Feel free to contact us at: [infiniteloopers@gmail.com](mailto:infiniteloopers@gmail.com)
-
-<details>
-    <summary> :lock: Secret Message</summary>
-    <br/>
-    <p>Thank you for opening this, Have a great day! :smile:</p>
-</details>
-
----
+---