docs: Update readme (#773)

Author: egekocabas

README.md

@@ -1,23 +1,65 @@
-# Helios :sun_with_face:
+<p align="center">
+  <!-- Icon by Sorasak Pinwiset on freeicons.io -->
+  <img src="docs/_static/images/helios-icon-1280x640.png" alt="Helios Icon" width="256" />
+</p>
+
+# Helios 🌞
 
 [![Build and Deploy to Prod](https://github.com/ls1intum/Helios/actions/workflows/prod.yml/badge.svg?branch=main)](https://github.com/ls1intum/Helios/actions/workflows/prod.yml)
-[![Documentation](https://github.com/ls1intum/Helios/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/ls1intum/Helios/actions/workflows/docs.yml)
+[![Deploy to Staging](https://github.com/ls1intum/Helios/actions/workflows/staging.yml/badge.svg?branch=staging)](https://github.com/ls1intum/Helios/actions/workflows/staging.yml)
+[![Tests](https://github.com/ls1intum/Helios/actions/workflows/test.yml/badge.svg?branch=staging)](https://github.com/ls1intum/Helios/actions/workflows/test.yml)
+[![Documentation](https://github.com/ls1intum/Helios/actions/workflows/docs.yml/badge.svg?branch=staging)](https://github.com/ls1intum/Helios/actions/workflows/docs.yml)
+[![Codacy Code Quality Badge](https://app.codacy.com/project/badge/Grade/c9a08eed385c43808b0e317505f5272d)](https://app.codacy.com/gh/ls1intum/Helios/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Coverage Badge](https://app.codacy.com/project/badge/Coverage/c9a08eed385c43808b0e317505f5272d)](https://app.codacy.com/gh/ls1intum/Helios/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![Latest version)](https://img.shields.io/github/v/tag/ls1intum/Helios?label=%20Latest%20version&sort=semver)](https://github.com/ls1intum/Helios/releases/latest)
+[![License](https://img.shields.io/github/license/ls1intum/Helios)](https://github.com/ls1intum/Helios/blob/staging/LICENSE)
+
 
+Helios brings clarity and control to GitHub Actions based CI/CD workflows. Named after the Greek god of the sun—symbolizing insight, reliability, and visibility—Helios offers:
 
-The personification of the sun, symbolizing light, clarity, and visibility that this app brings to CI/CD processes and test reliability
+- 🌟 **Unified Dashboard**  
+  All your branches, PRs, builds, test suites, and deployments in one canvas. Helios automatically syncs with GitHub, so you always see the latest activity.
 
-### Empowering Developers with a Dynamic User Interface for GitHub Actions
+- 🚀 **Smooth Deployment Flow**  
+  Pick from available environments with a friendly UI. Helios locks your chosen environment, prevents collisions, and displays live progress until tests finish or a timeout is reached.
 
-Welcome to the GitHub Actions UI Enhancement project! This project aims to develop a web application that enhances the usability of GitHub Actions by providing a dynamic user interface for developers. The application addresses key limitations such as the absence of a graphical interface, challenges in visualizing deployment targets, test case failures, and flaky tests.
+- 🔍 **Test Insights**  
+  No more scrolling through raw logs. Helios ingests structured reports (JUnit XML) so you can click into individual test suites and cases—see pass/fail, error messages, and log snippets. Track flaky tests across branches over time.
 
+- 📦 **Release Management**  
+  Draft, review, and publish release candidates without leaving Helios. Automatically generate release notes, tag your release, and see everything in one timeline.
 
-### Greek mythology
+---
 
-Helios was the Greek god and personification of the sun :sun_with_face: Each day, he was said to drive a golden chariot across the sky, bringing light to the world. According to mythology, Helios rose in the east and traveled across the heavens, guiding his chariot pulled by four horses. His daily journey from dawn to dusk symbolized reliability, consistency, and illumination.
+### Inspiration: Greek Mythology
+
+Helios was the Greek god and personification of the sun 🌞 Each day, he was said to drive a golden chariot across the sky, bringing light to the world. According to mythology, Helios rose in the east and traveled across the heavens, guiding his chariot pulled by four horses. His daily journey from dawn to dusk symbolized reliability, consistency, and illumination.
 
 Helios was also often depicted with a radiant crown, symbolizing the sun's light, and was considered an all-seeing deity, which aligns well with themes of visibility and clarity. These qualities made Helios a powerful symbol of insight and oversight in Greek culture.
 
 ## Documentation
 
-You can find the most recent documentation [here](https://ls1intum.github.io/Helios/).
+Full documentation is available at [ls1intum.github.io/Helios](https://ls1intum.github.io/Helios/), including:
+
+- User guide
+- How to contribute
+- Architecture overview
+- Production setup
+
+## Contributing & License
+
+- **Code of Conduct:** By participating in this project, you agree to abide by our [Code of Conduct](https://github.com/ls1intum/Helios/blob/staging/CODE_OF_CONDUCT.md).
+
+- **Contribution Guidelines:** To request commit access, learn about branching, issue reporting, and submitting pull requests, please see our [CONTRIBUTING.md](https://github.com/ls1intum/Helios/blob/staging/CONTRIBUTING.md).
+
+- **Repository Setup & Detailed Overview:** For instructions on setting up Helios locally, refer to our docs: 🔗 [ls1intum.github.io/Helios](https://ls1intum.github.io/Helios/)
+
+- **License:** Helios is released under the [MIT License](https://github.com/ls1intum/Helios/blob/staging/LICENSE). Feel free to fork, modify, and contribute back!  
+
+---
+
+## Credits & Attribution
+
+- [Helios icon](https://freeicons.io/greek-mythology-icon-set-2/helios-mythology-greek-god-sun-sol-icon-520979) made by [Sorasak Pinwiset](https://freeicons.io/profile/9025) on [freeicons.io](https://freeicons.io/).
+
+- Tunnel support provided by [ngrok](https://ngrok.com/).

docs/conf.py

@@ -86,4 +86,5 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Icon by Sorasak Pinwiset on freeicons.io
 html_favicon = '_static/favicon.png'

keycloakify/index.html

@@ -6,6 +6,7 @@
     <meta name="theme-color" content="default-color" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
 
+    <!-- Icon by Sorasak Pinwiset on freeicons.io -->
     <link rel="icon" type="image/png" sizes="32x32" href="/favicon.png" />
 </head>