Document course sections and the course sidebar - #619
Merged
Conversation
Student side: what sections are and how the sidebar with the series progress bars works, in the courses guide. Teacher side: grouping series into sections on the Manage series page (positional drag-and-drop membership, inline rename, deletion keeps the series), in the series-management guide where that page already lives. Fixes the stale Exercise Series heading reference: the UI says Learning path. Screenshot references are parked as comments until the SEC shots are captured. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
bmesuere
force-pushed
the
feat/docs-course-sections
branch
from
August 1, 2026 06:50
7ddf5c7 to
11f84a7
Compare
The sectioned course page, the sidebar with coloured per-series progress bars (shot as a member with real submission spread), the manage-series section row, and the admin empty-section state, in both languages. New course11-sections scenario groups the seeded series with the same positional semantics the reorder endpoint uses; the sidebar crop bounds to the nav's content instead of its full-height element. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Dodona documentation to explain course sections and the course sidebar for both students and teachers, and aligns the teacher docs with the current UI heading name (“Learning path” / “Leerpad”). It also extends the screenshot capture setup with a dedicated state scenario and manifest entries to support the new/updated guide screenshots.
Changes:
- Added student-facing documentation for Sections and the course sidebar (including progress bars and scrollspy behavior) in both EN and NL.
- Added teacher-facing documentation for grouping series into sections (add/rename/drag membership/delete semantics) in both EN and NL.
- Added screenshot automation support: a new
course11-sectionsstate scenario (setup/teardown) and new/updated shot definitions for the new visuals.
Reviewed changes
Copilot reviewed 11 out of 19 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| screenshots/state/course11-sections.setup.rb | Adds an idempotent Rails-runner scenario to create/reuse sections for course 11 and place series 51–54 into them (optionally adds an empty section). |
| screenshots/state/course11-sections.teardown.rb | Adds teardown script to remove the created sections and restore series ordering/section assignment. |
| screenshots/shots.yaml | Adds/updates shot definitions and state guidance for the new “sections” and “course sidebar” screenshots; uses a seeded user with progress data for student shots. |
| nl/guides/teachers/index.md | Updates the teacher guide index blurb to mention grouping series into sections. |
| nl/guides/teachers/exercise-series-management/index.md | Documents section grouping and management flow for teachers (NL). |
| nl/guides/teachers/course-management/index.md | Fixes the course-page heading reference to Leerpad and links to sections. |
| nl/guides/students/courses/index.md | Adds student documentation for sections and the sidebar (NL). |
| en/guides/teachers/index.md | Updates the teacher guide index blurb to mention grouping series into sections. |
| en/guides/teachers/exercise-series-management/index.md | Documents section grouping and management flow for teachers (EN). |
| en/guides/teachers/course-management/index.md | Fixes the course-page heading reference to Learning path and links to sections. |
| en/guides/students/courses/index.md | Adds student documentation for sections and the sidebar (EN). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request documents course sections and the course sidebar, integrated into existing pages rather than a new topic: the students' courses guide gains Sections and Course Sidebar subsections (grouped series, scrollspy, per-series progress bars, empty sections hidden from students), and the teachers' series-management guide gains Group series into sections (the Add section flow, inline rename, positional drag-and-drop membership where a series belongs to the section row above it, deletion keeps the series).
Also fixes a stale UI reference in course-management: the course page heading is
Learning path, notExercise Series.Manual testing instructions:
yarn check-linkspasses on this branch