You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Makes the public landing page show what Hephaestus actually does: real pull requests, review threads and issues with the feedback attached to them, Heph introducing himself, and a clearer account of who develops the project.
Copy file name to clipboardExpand all lines: README.md
+18-23Lines changed: 18 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
</picture>
7
7
8
8
<h1>Hephaestus</h1>
9
-
<p><strong>Feedback on how you work</strong></p>
9
+
<p><strong>Learn from the work you're already doing</strong></p>
10
10
11
11
<p>
12
12
<a href="https://hephaestus.aet.cit.tum.de"><img alt="Open the TUM-operated Hephaestus web app" src="https://img.shields.io/badge/web_app-open-493C83"></a>
@@ -21,20 +21,20 @@
21
21
</p>
22
22
</div>
23
23
24
-
Hephaestus gives developers feedback on the engineering practices they use in software projects. It draws on evidence from tools the team already uses — including GitHub or GitLab activity, selected Slack channels, and Outline documents — to explain what worked, what could improve, and what to try next.
24
+
Hephaestus connects feedback to software project work. When it finds evidence worth surfacing, feedback can explain what worked, what could improve, and a practical next step. Developers can ask Heph questions, add context, and compare options.
25
25
26
26
<divalign="center">
27
27
<picture>
28
-
<source media="(max-width: 520px) and (prefers-color-scheme: dark)" srcset="./docs/images/readme/landing-feedback-preview-mobile-dark.png">
29
-
<source media="(max-width: 520px) and (prefers-color-scheme: light)" srcset="./docs/images/readme/landing-feedback-preview-mobile-light.png">
<img alt="Example practice feedback on a focused change: Hephaestus notes that the change is easy to review and suggests explaining why it matters; the developer asks what to write, and Heph suggests a concise sentence." src="./docs/images/readme/landing-feedback-preview-light.png" width="744">
28
+
<source media="(max-width: 520px) and (prefers-color-scheme: dark)" srcset="./docs/images/readme/landing-hero-mobile-dark.png">
29
+
<source media="(max-width: 520px) and (prefers-color-scheme: light)" srcset="./docs/images/readme/landing-hero-mobile-light.png">
<img alt="Example showing a focused pull request, feedback about what worked and a possible next step, and a follow-up with Heph." src="./docs/images/readme/landing-hero-light.png" width="1224">
33
33
</picture>
34
-
<p><sub>One example of practice feedback and a follow-up with Heph.</sub></p>
34
+
<p><sub>An example of feedback connected to project work and explored with Heph.</sub></p>
35
35
</div>
36
36
37
-
Hephaestus is built for software engineering courses, open-source projects, and teams where mentors and maintainers cannot review every contribution themselves.
37
+
Hephaestus is built for software engineering courses, open-source projects, and engineering teams with shared working practices.
38
38
39
39
## What Hephaestus does
40
40
@@ -46,7 +46,7 @@ Hephaestus is built for software engineering courses, open-source projects, and
46
46
47
47
## How feedback works
48
48
49
-
The loop starts with a developer's project work and the context around it. Hephaestus reviews the work against the engineering practices configured for the workspace, turns what it finds into feedback, and delivers that feedback where it can help.
49
+
Hephaestus reviews project work against the engineering practices chosen for a workspace. Feedback points back to the work, and developers can ask Heph about the reasoning.
50
50
51
51
<picture>
52
52
<sourcemedia="(max-width: 640px) and (prefers-color-scheme: dark)"srcset="./docs/images/readme/feedback-loop-mobile-dark.png">
@@ -55,24 +55,19 @@ The loop starts with a developer's project work and the context around it. Hepha
55
55
<sourcemedia="(max-width: 1024px) and (prefers-color-scheme: light)"srcset="./docs/images/readme/feedback-loop-tablet-light.png">
<imgalt="Hephaestus feedback loop: project work and context are reviewed against workspace practices; practice feedback explains what worked, what could improve, and what to try next; it can appear alongside the work or in conversation with Heph; the developer decides whether to use, question, or skip it before their next piece of project work."src="./docs/images/readme/feedback-loop-light.png"width="1224">
58
+
<imgalt="Three steps in Hephaestus: open a contribution, review feedback connected to the work, and ask Heph a follow-up."src="./docs/images/readme/feedback-loop-light.png"width="1224">
59
59
</picture>
60
60
61
-
Developers decide what helps: use the feedback, question it, or skip it. The cycle continues with their next piece of project work. Hephaestus supports mentors, teachers, and maintainers by covering routine feedback. It does not replace their judgement or the relationships they build with developers.
61
+
Developers decide how to use the feedback and what to carry into their next contribution.
62
62
63
-
## Project status
63
+
## Project origins
64
+
65
+
Hephaestus is an [MIT-licensed](./LICENSE) open-source project developed by [Applied Education Technologies](https://aet.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/en/).
66
+
67
+
## Before upgrading
64
68
65
69
> [!IMPORTANT]
66
-
> **Hephaestus is still pre-1.0.** Until 1.0, a minor release can change configuration or APIs in ways that require action. If you self-host it, use the [latest release](https://github.com/ls1intum/Hephaestus/releases/latest), read its release notes and the [migration guide](./MIGRATION.md), and test upgrades in staging.
67
-
>
68
-
> We are aiming for a stable **v1.0.0 in mid-September 2026**. Here, stable means [predictable rules](./docs/admin/compatibility-policy.mdx) for upgrades, configuration, Docker Compose, and the REST API — not that development stops.
69
-
>
70
-
> Parts of this model already ship. For v1.0, the goal is to support them together as a stable product:
71
-
>
72
-
> -**Project context:** work in GitHub and GitLab, selected Slack channels, and selected Outline documents.
73
-
> -**Feedback delivery:** alongside work in GitHub or GitLab, in a personal view across projects, and in conversation with Heph in the web app or Slack.
74
-
>
75
-
> Release gates take priority over the date. Follow the [v1.0 milestone](https://github.com/ls1intum/Hephaestus/milestone/5) and [release plan](https://github.com/ls1intum/Hephaestus/issues/1377) for current scope and progress.
70
+
> Self-hosted upgrades can require configuration or API changes. Use the [latest release](https://github.com/ls1intum/Hephaestus/releases/latest), review the [compatibility policy](./docs/admin/compatibility-policy.mdx) and [migration guide](./MIGRATION.md), and test upgrades in staging.
0 commit comments