Skip to content

Commit df6b09e

Browse files
committed
Refine student quickstart and add Artemis launch flow
Add clear first-login/start instructions, integrate Artemis+Scorpio onboarding screenshots, and update submission guidance so students can launch and submit from either path.
1 parent 5af73b8 commit df6b09e

24 files changed

+218
-37
lines changed
Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,32 @@
11
---
22
title: First Login
3-
description: Mock onboarding guide for students.
3+
description: Sign in and reach the app launcher.
44
---
55

66
# First Login
77

8-
This mock page represents the first-run learner experience.
8+
Use this page for your first login flow.
99

10-
## Mock onboarding steps
10+
## 1) Open the login page
1111

12-
1. Sign in with the course account
13-
2. Join the correct course space
14-
3. Launch the first workspace
15-
4. Confirm editor, files, and terminal access
12+
Open `https://theia.artemis.cit.tum.de/` in your browser.
13+
14+
![Landing page with login button](/img/student/getting-started/first-login-01-landing-login.png)
15+
16+
## 2) Sign in with your account
17+
18+
Complete the login flow shown by your course setup.
19+
20+
<img src="/img/student/getting-started/first-login-02-sign-in-form.png" alt="Sign-in form" style={{maxHeight: 520}} />
21+
22+
## 3) Confirm you reached the launcher
23+
24+
After login, you should see the IDE app tiles.
25+
26+
![IDE launcher after login](/img/student/getting-started/first-login-03-launcher-after-login.png)
27+
28+
## Next step
29+
30+
Continue with [First Start](./first-start.md).
31+
32+
If your course starts from Artemis exercises, you can also use [Start from Artemis](./start-from-artemis.md).
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: First Start
3+
description: Launch your first Java workspace in under two minutes.
4+
---
5+
6+
# First Start
7+
8+
Use this page for your first start.
9+
10+
## 1) Open the launcher
11+
12+
After login, go to the IDE launcher page with the app tiles.
13+
14+
<img src="/img/student/getting-started/first-login-03-launcher-after-login.png" alt="IDE launcher page" style={{maxHeight: 520}} />
15+
16+
## 2) Launch Java
17+
18+
Click **Launch Java**.
19+
20+
![Launch Java tile](/img/student/getting-started/student-02-launch-java-tile.png)
21+
22+
## 3) Wait for the IDE to open
23+
24+
The IDE opens in a new session URL.
25+
26+
![Java workspace opened](/img/student/getting-started/student-03-ide-opened-welcome.png)
27+
28+
## 4) Quick success check
29+
30+
Open a terminal and run:
31+
32+
```bash
33+
java -version
34+
```
35+
36+
If you see a Java version output, your workspace is ready.
37+
38+
![Terminal java version check](/img/student/getting-started/student-04-java-version-terminal.png)
39+
40+
## Next step
41+
42+
Continue with the [Workspace Tour](./workspace-tour.md).
43+
44+
If your course launches from Artemis, use [Start from Artemis](./start-from-artemis.md).
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Start from Artemis
3+
description: Open your exercise in EduIDE directly from Artemis.
4+
---
5+
6+
# Start from Artemis
7+
8+
Use this path when you begin from an Artemis exercise page.
9+
10+
## 1) Start the exercise
11+
12+
Open your exercise in Artemis and click **Start exercise**.
13+
14+
![Start exercise in Artemis](/img/student/getting-started/artemis-01-start-exercise.png)
15+
16+
## 2) Open the online IDE
17+
18+
In the repository section, click **Open online IDE**.
19+
20+
![Open online IDE from Artemis](/img/student/getting-started/artemis-02-open-online-ide.png)
21+
22+
## 3) First-login retry (current workaround)
23+
24+
If you are asked to log in, complete login, return to the Artemis exercise page, and click **Open online IDE** again.
25+
26+
This can happen on the first login.
27+
28+
## 4) Continue in EduIDE
29+
30+
When the IDE opens, continue with the [Workspace Tour](./workspace-tour.md).
Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,37 @@
11
---
22
title: Workspace Tour
3-
description: Mock workspace orientation for students.
3+
description: Quick orientation of the EduIDE layout.
44
---
55

66
# Workspace Tour
77

8-
This placeholder page shows where a lightweight orientation guide would go.
8+
This is the minimal layout you need to start working.
99

10-
## Mock tour stops
10+
![IDE layout overview](/img/student/getting-started/workspace-tour-01-welcome-screen.png)
1111

12-
- File explorer
13-
- Editor tabs
14-
- Terminal panel
15-
- Assignment instructions
16-
- Submission status
12+
## Main areas
13+
14+
- **Explorer (left):** your files and folders
15+
- **Editor (center):** where you write code
16+
- **Terminal (bottom):** compile and run commands
17+
- **Problems (bottom):** diagnostics and warnings
18+
19+
## Useful first action
20+
21+
Open **Terminal -> New Terminal**.
22+
23+
![Open new terminal from top menu](/img/student/getting-started/workspace-tour-02-open-terminal-menu.png)
24+
25+
Open the terminal and run:
26+
27+
```bash
28+
pwd
29+
```
30+
31+
You should see your workspace path (usually `/home/project`).
32+
33+
![Terminal current directory output](/img/student/getting-started/workspace-tour-03-terminal-pwd.png)
34+
35+
## Next step
36+
37+
Continue with the [Assignment Workflow](../learning/assignment-workflow.md).

docs/student/intro.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,28 @@
11
---
22
title: Student Overview
3-
description: Mock student-facing documentation landing page.
3+
description: Quickstart guide for students using EduIDE.
44
---
55

66
# Student Overview
77

8-
This section is for learners using EduIDE in courses.
8+
Welcome to EduIDE. This guide helps you get coding quickly in your course workspace.
99

10-
It should stay simple, task-oriented, and separate from instructor or admin detail.
10+
You do not need local setup. Everything runs in your browser.
1111

12-
## What lives here
12+
## Start here
1313

14-
- First login and workspace orientation
15-
- Assignment and submission workflows
16-
- Practical help for common blockers
14+
1. [First Login](./getting-started/first-login.md)
15+
2. [First Start](./getting-started/first-start.md)
16+
3. [Start from Artemis](./getting-started/start-from-artemis.md)
17+
4. [Workspace Tour](./getting-started/workspace-tour.md)
18+
5. [Assignment Workflow](./learning/assignment-workflow.md)
19+
6. [Submission Checklist](./learning/submission-checklist.md)
20+
21+
## What this section covers
22+
23+
- logging in to the platform
24+
- launching your Java workspace
25+
- launching from Artemis exercises
26+
- navigating the IDE layout
27+
- editing, compiling, and running code from the terminal
28+
- submitting with the Scorpio extension and checking feedback
Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,48 @@
11
---
22
title: Assignment Workflow
3-
description: Mock assignment workflow guide for students.
3+
description: Quick terminal-first workflow for Java assignments.
44
---
55

66
# Assignment Workflow
77

8-
This mock page is the future home for practical guidance on completing and submitting coursework.
8+
Use this flow when you work on Java tasks.
99

10-
## Mock workflow
10+
## 1) Open the assignment file
1111

12-
1. Read the assignment brief
13-
2. Work inside the provided workspace
14-
3. Run local checks before submitting
15-
4. Submit and review status feedback
12+
Open `BubbleSort.java` in the editor.
13+
14+
![BubbleSort opened in editor](/img/student/learning/assignment-01-open-bubblesort.png)
15+
16+
## 2) Make your code change
17+
18+
Edit the method for your task.
19+
20+
![BubbleSort after implementing method](/img/student/learning/assignment-02-edit-bubblesort.png)
21+
22+
## 3) Run in terminal
23+
24+
Run:
25+
26+
```bash
27+
java BubbleSort.java
28+
```
29+
30+
If there is an error, fix it and run the command again.
31+
32+
![Run BubbleSort.java in terminal](/img/student/learning/assignment-03-run-bubblesort-command.png)
33+
34+
35+
## 4) Check the output
36+
37+
Confirm that the program output matches the expected sorted order.
38+
39+
![BubbleSort terminal output](/img/student/learning/assignment-04-run-bubblesort-output.png)
40+
41+
## 5) Final quick check
42+
43+
- file saved
44+
- program runs successfully
45+
- output matches expectation
46+
- ready to submit in Scorpio
47+
48+
Then continue with the [Submission Checklist](./submission-checklist.md).
Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,34 @@
11
---
22
title: Submission Checklist
3-
description: Mock submission checklist for students.
3+
description: Submit with Scorpio and review feedback in Artemis flow.
44
---
55

66
# Submission Checklist
77

8-
This placeholder page keeps learner support content focused and direct.
8+
Use this checklist to submit your work from the IDE.
99

10-
## Mock checklist
10+
## 1) Open Scorpio
1111

12-
- Latest changes saved
13-
- Required tests executed
14-
- Submission target selected
15-
- Confirmation status recorded
12+
In the IDE activity bar, open **Artemis: Scorpio**.
13+
14+
## 2) Verify exercise details
15+
16+
Make sure the correct exercise and task are shown.
17+
18+
## 3) Submit your exercise
19+
20+
Click **Submit Exercise**.
21+
22+
![Scorpio extension with submit button and feedback area](/img/student/learning/scorpio-01-submit-and-feedback.png)
23+
24+
## 4) Review feedback
25+
26+
Check the latest result in the same panel.
27+
28+
If feedback is delayed, wait a moment and refresh the panel.
29+
30+
## Done when
31+
32+
- code is saved
33+
- submission was sent
34+
- latest feedback was checked

sidebarsStudent.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ const sidebars: SidebarsConfig = {
66
{
77
type: 'category',
88
label: 'Getting Started',
9-
items: ['getting-started/first-login', 'getting-started/workspace-tour'],
9+
items: [
10+
'getting-started/first-login',
11+
'getting-started/first-start',
12+
'getting-started/start-from-artemis',
13+
'getting-started/workspace-tour',
14+
],
1015
},
1116
{
1217
type: 'category',
411 KB
Loading
43.6 KB
Loading

0 commit comments

Comments
 (0)