Getting started
Before you start
You need:
- an account with one of the sign-in providers offered by your Hephaestus deployment
- access to at least one workspace
- a current version of Chrome, Edge, Firefox, or Safari
The public TUM deployment is available at hephaestus.aet.cit.tum.de. Other deployments can offer different sign-in providers and features.
Sign in
- Open your Hephaestus deployment.
- Select Sign in.
- Choose one of the available providers and complete its sign-in flow.
- Select a workspace from the workspace switcher.
If you do not have a workspace, ask an instance admin to create one or add you. Some deployments also allow eligible users to select Create workspace from the workspace switcher.
Find your way around
The navigation changes with the features enabled for your workspace.
| Area | What you can do |
|---|---|
| Profile | View a developer's recent activity and, when enabled, progress and league information. |
| Teams | Browse the teams and repositories synced into the workspace. |
| Achievements | View earned achievements when the feature is enabled. |
| Leaderboard | View the optional weekly ranking of review activity. |
| Heph | Start a chat about your feedback and recent work when the mentor is enabled for you. |
| Admin | Configure the workspace if you are a workspace admin. |
| Settings | Manage your account, linked identities, sessions, and personal preferences. |
Features that are off do not appear in the navigation.
Try the core workflows
Read practice feedback
When practice reviews are enabled, Hephaestus reviews eligible pull requests, merge requests, and issues in connected repositories. The comment explains the practice it found, points to evidence, and suggests a next step.
See Practice feedback for triggers, comment structure, and the personal comment-delivery setting.
Chat with Heph
Open Heph, start a new chat, and ask about a piece of feedback or recent work. Heph can use your recent issues, commits, reviews, pull or merge requests, and feedback you have received as context.
See Chat with Heph for examples and privacy notes.
Switch workspaces
Use the workspace switcher at the top of the sidebar. Each workspace has its own repositories, members, practice catalog, integrations, and feature settings.
Connected services
- GitHub or GitLab supplies the repository activity used by the workspace.
- Slack, when connected, lets you chat with Heph in a direct message. Workspace admins can separately configure weekly leaderboard digests and monitored channels.
- Outline, when connected, lets Hephaestus read selected team documents that are relevant to linked work. Connecting your own Outline account attributes documents you authored to you.
Need help? Use Help & feedback in the footer or ask in GitHub Discussions.