90 docs navigation (#314)

* docs: 📝 update main readme

* docs: Update local setup instructions in README.md and fix typo in design/README.md

README.md

@@ -1,35 +1,42 @@
-# Hypso Outreach Portal
+# Hypso Space Outreach
+
+
+
+## Project Objectives
+
+* Develop an interactive web page for the general public.
+* Include features such as mission tracker, mission status, maps, and automatic posting.
+* Prioritize operational cost-effectiveness and ease of maintenance in technology and framework choices. 
 
 ## General Information  
-Project Code: P.01  
-Country: 🇳🇴 Norway  
-Customer: NTNU SmallSat Lab  
-Platform: Web  
-Framework: React  
-Period: Spring 2024  
-Status: In Progress  
 
-## Project Title
-Hypso Outreach Portal
+* Country: 🇳🇴 Norway  
+* Customer: NTNU SmallSat Lab  
+* Platform: Web  
+* Framework: React  
+* Period: Spring 2024  
+* Status: In Progress  
 
-## Description
-In January 2022, NTNU SmallSatLab launched Norway's first research satellite, the 6U HYPSO-1 CubeSat, equipped with a hyperspectral camera for ocean observation. Later the same year, Orbit NTNU launched the SelfieSat. With several more satellites planned, we aim to develop an interactive webpage for public outreach about our project. This page will showcase various elements such as a mission tracker, mission status with nerdy counters, satellite maps, and the possibility to post blogs or images.
+## Project Structure
 
-## Project Objectives
-- Develop an interactive web page for the general public.
-- Consider elements like mission tracker, mission status, maps, and automatic posting features.
-- Evaluate technology and framework choices, considering operational cost and maintenance simplicity.
-
-## Additional Notes
-- Location: Trondheim, with potential work at SmallSatLab.
-- Encouragement to join SmallSatLab team events.
-- Usage of NTNU-hosted web server and GitHub for code deployment.
-
-## Group Members
-- Mads Hermansen
-- Lukas Ringdalen Thrane
-- Magnus Alexander Strømseng
-- Jakob Grøtan Gregusson
-- Lucas Tran
-- Mats Nyfløt
-- Elias Schrøder Knudsen
+* `/docs/`: Contains technical documentation.
+* `/backend/`: Backend code and local setup instructions.
+* `/frontend/`: Frontend code and local setup instructions.
+* `/.vscode/`: IDE settings (if applicable).
+* `/.github/`: GitHub repository settings (e.g., issue templates, workflows).
+
+## Getting Started
+
+**Instructions:**
+
+1. Clone this repository.
+2. Navigate to the `backend/` directory and follow the instructions within.
+3. Navigate to the `frontend/` directory and follow the instructions within
+
+## Contributing
+
+We welcome contributions!
+
+## More Info
+
+If looking for more information about the project please refer to the submitted report which Small Satellite Lab should have access to as well as the documentation in the `/docs/` folder.

docs/README.md

@@ -8,15 +8,14 @@ Welcome to the `docs/` directory! This folder is an essential part of the Hypso
 ## Contents
 In this folder, you will find a range of documents that support and explain the project. This includes but is not limited to:
 
-- **Project Documentation:** Detailed descriptions of the project's architecture, design decisions, and implementation details.
-- **Comments and Annotations:** Notes and comments from the development team, providing insights into specific choices and approaches.
 - **User Guides:** Step-by-step guides and manuals for end-users, ensuring ease of use and accessibility of our platform.
 - **Technical References:** References to technologies, frameworks, libraries, and tools used in the project.
 
+Other information about the project is within the submitted report detailing architecture, reasoning and more.
+
 ## Purpose
 The primary purpose of this folder is to:
 
 1. **Organize Information:** Keep all documentation in one accessible location.
 2. **Facilitate Collaboration:** Provide team members with easy access to essential project information.
-3. **Support Maintenance:** Aid future developers in understanding and maintaining the system.
-4. **Enhance User Experience:** Offer clear guidance to users for navigating and utilizing the platform effectively.
+3. **Support Maintenance:** Aid future developers in understanding and maintaining the system.

docs/design/README.md

@@ -6,9 +6,11 @@ Welcome to our design folder! This folder is dedicated to storing and organizing
 
 This Folder is organized into the following folders:
 
-1. **Iterasjon1**: This folder contains the initial design concepts and drafts for the project. It includes early-stage sketches, wireframes, and basic prototypes.
+1. **iteration-1**: This folder contains the initial design concepts and drafts for the project. It includes early-stage sketches, wireframes, and basic prototypes.
+
+2. **iteration-2**: Here, you will find the refined designs that were developed based on feedback and further brainstorming from Iterasjon1. This includes more detailed prototypes, higher fidelity wireframes, and potentially some initial UI elements.
+3. **iteration-3**: Here, you will find the final designs that we used for the project.
 
-2. **Iterasjon2**: Here, you will find the refined designs that were developed based on feedback and further brainstorming from Iterasjon1. This includes more detailed prototypes, higher fidelity wireframes, and potentially some initial UI elements.
 
 ## Accessing Design Files