Skip to content

Document the remaining small topics from the gap list - #621

Merged
bmesuere merged 2 commits into
mainfrom
feat/docs-small-topics
Aug 1, 2026
Merged

Document the remaining small topics from the gap list#621
bmesuere merged 2 commits into
mainfrom
feat/docs-small-topics

Conversation

@bmesuere

@bmesuere bmesuere commented Aug 1, 2026

Copy link
Copy Markdown
Member

This pull request executes the last items of the coverage gap list, in both languages, every UI string verified against the locales:

  • Student courses guide: favourite courses (heart, homepage Favorites row), the iCal deadline feed (Add course to calendar, what the feed contains), and archived courses (the banner, read-only semantics, the Hide archived switch).
  • Login-and-settings: the theme picker (Light/Dark/System, persisted to the account).
  • A new notifications FAQ: when notifications happen (comments on your code — including answers to questions, which technically arrive as annotations — and released evaluation feedback), managing them, and the reader side of announcement banners (creating them is staff-only, so no teacher tooling is documented).
  • Course-management: the two-sentence Dolos mention becomes a proper walkthrough (canonical home; grading cross-links instead of duplicating), with modest claims about the external report.
  • Activities FAQ: corrected stale draft-activity answers against the current publish flow, plus new entries for read states and activity statuses. The Dutch heading takes its old name back so the app's existing deep link resolves; the app-side change was dropped from dodona#8710 accordingly.
  • Accounts FAQ: a proper How do I get teacher rights entry.

Manual testing instructions:

  • yarn check-links passes on this branch
  • Spot-check the new FAQ entries and course-guide sections against the dev UI in both languages

Favourite and archived courses and the iCal deadline feed in the
student courses guide; a theme picker section in login-and-settings; a
proper Dolos walkthrough with one canonical home in course-management;
a new notifications FAQ (when notifications happen, managing them, and
the reader side of announcement banners — creation is staff-only); an
expanded and corrected activities FAQ including read states; and a
teacher-rights entry in the accounts FAQ. The Dutch draft-activity
heading gets its old name back so the app's existing deep link works
again. Every UI string verified against the locales in both languages;
declared-but-uncaptured manifest entries added for the new sections.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@bmesuere bmesuere added the documentation Improvements or additions to documentation label Aug 1, 2026
@bmesuere bmesuere self-assigned this Aug 1, 2026
The favourites row, the course calendar menu, the archived-course
banner (a seeded archived course, no state change needed), the
notification bell and page, and the announcement banner — which gets
realistic maintenance-announcement text for the shot instead of the
seeded lorem, restored afterwards. The announcement hook un-hides the
element the capture CSS suppresses everywhere else.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Base automatically changed from feat/docs-course-sections to main August 1, 2026 14:10
@bmesuere
bmesuere marked this pull request as ready for review August 1, 2026 14:13
Copilot AI review requested due to automatic review settings August 1, 2026 14:13
@bmesuere
bmesuere merged commit 4ef6559 into main Aug 1, 2026
1 check passed
@bmesuere
bmesuere deleted the feat/docs-small-topics branch August 1, 2026 14:13

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Not ready to approve

A few newly added/updated documentation lines contain confirmed grammar/punctuation issues that should be corrected before merge.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.

Pull request overview

This PR completes the remaining “coverage gap list” documentation items by expanding/adding student and teacher docs (EN/NL) and introducing new screenshot scenarios/hooks to capture the new UI topics reliably.

Changes:

  • Add EN/NL documentation for favourites, calendar feed, archived courses, and theme selection.
  • Add a new EN/NL Notifications FAQ and extend EN/NL FAQs for activities (draft/read/status) and accounts (teacher rights).
  • Extend teacher course-management/grading docs with a fuller Dolos walkthrough and add screenshot state + hook support for the new “small topics” pages.
File summaries
File Description
screenshots/state/sm-favorites.teardown.rb Teardown script to restore seeded “favorite course” state after screenshots.
screenshots/state/sm-favorites.setup.rb Setup script to ensure a favourited course exists for screenshots.
screenshots/shots.yaml Adds the “small-topics” screenshot batch (favourites, calendar menu, archived banner, notifications, announcement).
screenshots/hooks/sm-announcement.mjs Hook to force-show the announcement banner for its dedicated screenshot.
nl/guides/teachers/grading/index.md Updates Dolos naming and links to the expanded Dolos walkthrough.
nl/guides/teachers/course-management/index.md Adds a dedicated “Plagiaat detecteren met Dolos” walkthrough section.
nl/guides/students/login-and-settings/index.md Documents theme selection (Licht/Donker/Systeem).
nl/guides/students/courses/index.md Documents favourites, iCalendar feed, and archived course semantics.
nl/faq/notifications/index.md New NL Notifications FAQ.
nl/faq/index.md Adds NL FAQ index entries for notifications, activities updates, and teacher rights.
nl/faq/activities/index.md Updates draft/concept explanation; adds read-state and status FAQ entries.
nl/faq/accounts/index.md Adds NL “How to get teacher rights?” entry.
en/guides/teachers/grading/index.md Updates Dolos naming and links to the expanded Dolos walkthrough.
en/guides/teachers/course-management/index.md Adds a dedicated “Detecting Plagiarism with Dolos” walkthrough section.
en/guides/students/login-and-settings/index.md Documents theme selection (Light/Dark/System).
en/guides/students/courses/index.md Documents favourites, iCalendar feed, and archived course semantics.
en/faq/notifications/index.md New EN Notifications FAQ.
en/faq/index.md Adds EN FAQ index entries for notifications, activities updates, and teacher rights.
en/faq/activities/index.md Updates draft explanation; adds read-state and status FAQ entries.
en/faq/accounts/index.md Adds EN “How do I get teacher rights?” entry.
Review details
  • Files reviewed: 20/32 changed files
  • Comments generated: 3
  • Review effort level: Lite

We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.

Dodona notifies you when something needs your attention:

- when a teacher comments on your code or replies to one of your [questions](../annotations/#how-can-i-ask-a-question-about-my-code), you receive the notification `There is a new comment on your code`;
- when a teacher releases the feedback of an evaluation (for example a graded task, test, or exam) you took part in, you receive the notification `Feedback was added to your code.`.

## Favoriete cursussen

Op je startpagina wordt elke cursus waarvoor je geregistreerd bent weergegeven als een cursuskaart. Onderaan zo'n kaart vind je een hartje waarmee je de cursus als favoriet kan markeren (`Voeg toe aan favorieten`). Je favoriete cursussen verschijnen in een aparte rij `Favorieten` bovenaan je startpagina, boven de andere cursussen, zodat je snel bij de cursussen kan waarin je het vaakst werkt. Die rij wordt altijd getoond, ongeacht het academiejaar dat je selecteerde, dus dit is ook een handige manier om een cursus uit een vorig academiejaar binnen handbereik te houden. Klik opnieuw op het hartje (`Verwijder uit favorieten`) om een cursus uit je favorieten te halen.
## Wat is een concept? <Badge type="tip" text="lesgever" />
Een concept is een oefening of leesactiviteit die nog niet is gepubliceerd. Concepten zijn alleen zichtbaar voor de eigenaars van de repository en cursusbeheerders en worden gebruikt om oefeningen te maken en te testen voordat ze worden gepubliceerd. Als je een nieuwe oefening aan Dodona toevoegt, dan zal die automatisch in conceptmodus staan tot je ze publiceert.
## Wat is een conceptactiviteit? <Badge type="tip" text="lesgever" />
Een concept is een oefening of leesactiviteit die nog niet is gepubliceerd. Concepten zijn nooit zichtbaar voor studenten en worden gebruikt om oefeningen te maken en te testen voordat ze worden gepubliceerd. Als je een nieuwe oefening aan Dodona toevoegt, dan zal die automatisch in conceptmodus staan tot je ze publiceert.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants