Skip to content

Commit dfee18a

Browse files
feat(webapp): strengthen public landing experience
1 parent c6435a4 commit dfee18a

41 files changed

Lines changed: 418 additions & 1073 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changeset/calm-mentors-welcome.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"hephaestus": patch
3+
---
4+
5+
Clarifies how practice feedback and Heph support learning from project work, and identifies the project's Applied Education Technologies and TUM origins.

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</picture>
77

88
<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>
1010

1111
<p>
1212
<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,7 +21,7 @@
2121
</p>
2222
</div>
2323

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 uses AI to give developers feedback on engineering practices in their project work. Feedback points to the work that prompted it and explains what worked, what could improve, and what to try next. Developers can discuss it with Heph, Hephaestus's conversational AI mentor.
2525

2626
<div align="center">
2727
<picture>
@@ -34,7 +34,7 @@ Hephaestus gives developers feedback on the engineering practices they use in so
3434
<p><sub>One example of practice feedback and a follow-up with Heph.</sub></p>
3535
</div>
3636

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 teams that want more consistent opportunities to learn from day-to-day contributions.
3838

3939
## What Hephaestus does
4040

@@ -58,7 +58,11 @@ The loop starts with a developer's project work and the context around it. Hepha
5858
<img alt="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">
5959
</picture>
6060

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 what helps: use the feedback, question it with Heph, or skip it. The cycle continues with their next piece of project work. The feedback can extend the attention available from mentors and maintainers, but it remains AI-generated advice rather than a decision or assessment of a person.
62+
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/).
6266

6367
## Project status
6468

docs/docusaurus.config.ts

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,15 @@ import {themes as prismThemes} from 'prism-react-renderer';
22
import type {Config} from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

5-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6-
75
const envBaseUrl = process.env.DOCUSAURUS_BASE_URL;
86

97
const config: Config = {
108
title: 'Hephaestus Documentation',
11-
tagline: 'Feedback on how you work',
9+
tagline: "Learn from the work you're already doing",
1210
favicon: 'img/favicon.ico',
1311

14-
// Future flags and performance optimizations
15-
// See https://docusaurus.io/docs/api/docusaurus-config#future
1612
future: {
1713
v4: true,
18-
// Docusaurus Faster: Uses Rspack, SWC, and LightningCSS for 2-4x faster builds
19-
// https://docusaurus.io/blog/releases/3.6#docusaurus-faster
2014
faster: {
2115
swcJsLoader: true,
2216
swcJsMinimizer: true,
@@ -39,9 +33,6 @@ const config: Config = {
3933
onDuplicateRoutes: 'throw',
4034
trailingSlash: false,
4135

42-
// Even if you don't use internationalization, you can use this field to set
43-
// useful metadata like html lang. For example, if your site is Chinese, you
44-
// may want to replace "en" with "zh-Hans".
4536
i18n: {
4637
defaultLocale: 'en',
4738
locales: ['en'],
@@ -71,15 +62,12 @@ const config: Config = {
7162
theme: {
7263
customCss: './src/css/custom.css',
7364
},
74-
// Sitemap generation with lastmod for SEO
7565
sitemap: {
7666
lastmod: 'datetime',
7767
changefreq: 'weekly',
7868
priority: 0.5,
7969
filename: 'sitemap.xml',
8070
},
81-
// Google Tag Manager can be configured here if needed
82-
// gtag: { trackingID: 'G-XXXXXXXXXX' },
8371
} satisfies Preset.Options,
8472
],
8573
],
@@ -152,7 +140,7 @@ const config: Config = {
152140
{
153141
name: 'description',
154142
content:
155-
'Hephaestus gives developers practice feedback on software project work, plus an AI mentor for talking through feedback and next steps.',
143+
'Hephaestus gives developers practice feedback on software project work and lets them discuss it with Heph, its conversational AI mentor.',
156144
},
157145
{name: 'keywords', content: 'Hephaestus, AI mentor, code review feedback, software engineering practices, TUM'},
158146
{name: 'twitter:card', content: 'summary_large_image'},
@@ -161,7 +149,7 @@ const config: Config = {
161149
{
162150
name: 'twitter:description',
163151
content:
164-
'Hephaestus gives developers practice feedback on software project work, plus an AI mentor for talking through feedback and next steps.',
152+
'Hephaestus gives developers practice feedback on software project work and lets them discuss it with Heph, its conversational AI mentor.',
165153
},
166154
],
167155
navbar: {
@@ -252,7 +240,7 @@ const config: Config = {
252240
],
253241
},
254242
{
255-
title: 'Community',
243+
title: 'Project',
256244
items: [
257245
{
258246
label: 'Applied Education Technologies',
@@ -265,15 +253,14 @@ const config: Config = {
265253
],
266254
},
267255
],
268-
copyright: `© ${new Date().getFullYear()} Technical University of Munich · Built with ❤️ by the Hephaestus Team at Applied Education Technologies (AET)`,
256+
copyright: `Hephaestus is an MIT-licensed open-source project developed by Applied Education Technologies at the Technical University of Munich.`,
269257
},
270258
docs: {
271259
sidebar: {
272260
hideable: true,
273261
autoCollapseCategories: true,
274262
},
275263
},
276-
// Table of contents configuration
277264
tableOfContents: {
278265
minHeadingLevel: 2,
279266
maxHeadingLevel: 4,
-111 KB
Loading
-121 KB
Loading
-59.5 KB
Loading
-54.3 KB
Loading
-68.6 KB
Loading
-62.9 KB
Loading
-83.9 KB
Loading

0 commit comments

Comments
 (0)