Skip to content

Commit 1d3995c

Browse files
docs: rebuild the documentation homepage around its readers
The homepage showed a screenshot of the web app's landing page beside a heading the screenshot already contained, so the tagline appeared twice. The asset pipeline now exports the scene alone — the four cards of one change and the feedback attached to them — and both the README and the docs site use that instead. Around it the page becomes a documentation homepage rather than a compressed marketing one: search is visible where a visitor lands, the pre-1.0 support window is stated in an announcement bar instead of only inside the compatibility policy, and each guide card names its audience and links the pages that audience opens first. Also: the exact mentor accent from the web app, themed shadows that survive dark mode, an accessible heading for the feature section, imprint and privacy in the footer, descriptions on twelve pages that had none, and the removal of the unused template sidebar, seven orphaned screenshots and the sidebar_position frontmatter that ordered nothing and contradicted itself. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent fcbfa8c commit 1d3995c

55 files changed

Lines changed: 262 additions & 172 deletions

Some content is hidden

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

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ replace mentors: the harder judgement and the relationships stay with people.
3131

3232
<div align="center">
3333
<picture>
34-
<source media="(prefers-color-scheme: dark)" srcset="./docs/images/readme/landing-hero-dark.png">
35-
<source media="(prefers-color-scheme: light)" srcset="./docs/images/readme/landing-hero-light.png">
36-
<img alt="An illustration of one change through a project: issue #412 has no acceptance criteria, the pull request grew to 34 files and picked up an unrelated rename, a reviewer asks a good question, and it merges with that thread unresolved. Hephaestus points back to the issue." src="./docs/images/readme/landing-hero-light.png" width="1280">
34+
<source media="(prefers-color-scheme: dark)" srcset="./docs/images/readme/feedback-scene-dark.png">
35+
<source media="(prefers-color-scheme: light)" srcset="./docs/images/readme/feedback-scene-light.png">
36+
<img alt="Four cards from one change — an issue with no acceptance criteria, a pull request that grew to 34 files, a review question, and the merge that left it unanswered — each with the practice feedback Hephaestus attached to it." src="./docs/images/readme/feedback-scene-light.png" width="896">
3737
</picture>
38-
<p><sub>An illustration of the kind of feedback Hephaestus writes. See the <a href="https://ls1intum.github.io/Hephaestus/user/ai-code-review">user guide</a> for the real interface.</sub></p>
38+
<p><sub>An illustration of the feedback Hephaestus writes. See the <a href="https://ls1intum.github.io/Hephaestus/user/ai-code-review">user guide</a> for the real interface.</sub></p>
3939
</div>
4040

4141
> [!IMPORTANT]
@@ -127,5 +127,5 @@ quality checks, and open a pull request. Participation in the project is governe
127127
Hephaestus is an [MIT-licensed](./LICENSE) open-source project developed by
128128
[Applied Education Technologies](https://aet.cit.tum.de/) at the
129129
[Technical University of Munich](https://www.tum.de/en/). It is named after the Greek god of the
130-
forge. In the myth Plato tells, his craft was carried out of the workshop and handed to people so
131-
they could build for themselves — which is roughly the idea here.
130+
forge, whose craft — in the myth Plato tellswas stolen from his workshop and given to people so
131+
they could make things for themselves.

docs/admin/ai-providers.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: ai-providers
3-
sidebar_position: 2
43
title: Connect an AI Provider
54
description: Register an OpenAI-compatible provider, test it, price its models, and share them — field by field, with what a failed probe actually means.
65
---

docs/admin/backup-restore.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: backup-restore
3-
sidebar_position: 3
43
title: Backup & Restore
54
description: What to back up on a self-hosted instance, and how to restore it.
65
---

docs/admin/buildpacks-cds-decision.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
id: buildpacks-cds-decision
33
title: Server image build via Paketo Buildpacks + Application CDS
4-
sidebar_position: 4
54
description: How and why the application-server image is built with Paketo Cloud Native Buildpacks + Application CDS, and the Java 25 + JEP 483 migration path.
65
---
76

docs/admin/compatibility-policy.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: compatibility-policy
3-
sidebar_position: 2
43
title: Compatibility Policy
54
description: What a Hephaestus version number promises — the public contract, upgrade guarantees, and support statement.
65
---

docs/admin/github-integration.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: github-integration
3-
sidebar_position: 2
43
title: GitHub Integration
54
description: OAuth App for login, PAT or GitHub App for data access, and manual webhook setup.
65
---

docs/admin/install.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: install
3-
sidebar_position: 0
43
title: Install (Self-Hosted)
54
description: The one supported way to run your own Hephaestus — Docker Compose on a single host.
65
---

docs/admin/legal-pages.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: legal-pages
3-
sidebar_position: 2
43
title: Legal Pages (Imprint & Privacy)
54
description: How Hephaestus resolves the /imprint and /privacy pages, and what the operator of a self-hosted deployment is responsible for.
65
---

docs/admin/overview.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: overview
3-
sidebar_position: -1
43
title: Admin overview
54
description: What a Hephaestus deployment consists of and the order to set it up in.
65
---

docs/admin/practice-catalog.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
id: practice-catalog
3-
sidebar_position: 4
43
title: Practice Catalog
54
description: Curate the practices an instance offers, adopt them into a workspace, and read the badges that say when a workspace copy and the catalog have drifted apart.
65
---

0 commit comments

Comments
 (0)