Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation feedback and improvements #360

Merged
merged 51 commits into from
Jan 23, 2024
Merged

Documentation feedback and improvements #360

merged 51 commits into from
Jan 23, 2024

Conversation

BTWS2
Copy link
Contributor

@BTWS2 BTWS2 commented Nov 17, 2023

Closes #333
Based on dodona-edu/dodona#3216
Closes #359

@pdawyndt
Copy link
Contributor

pdawyndt commented Nov 17, 2023

@niknetniko: I see the documentation still mentions the feedback hierarchy as tab-contexts-testcases; isn't this something we already changed into more common software testing lingo: unit-cases-test? The old names are probably still supported, but the documentation should preferably mention the recommended attributes.

@BTWS2 BTWS2 marked this pull request as ready for review November 17, 2023 19:30
@jorg-vr jorg-vr requested review from niknetniko and bmesuere January 3, 2024 10:26
.idea/.gitignore Outdated Show resolved Hide resolved
en/faq/activities/index.md Outdated Show resolved Hide resolved
en/references/judges/index.md Outdated Show resolved Hide resolved
nl/faq/activities/index.md Outdated Show resolved Hide resolved
nl/references/judges/index.md Outdated Show resolved Hide resolved
nl/references/exercise-description/index.md Show resolved Hide resolved
nl/references/exercise-description/index.md Outdated Show resolved Hide resolved
nl/references/exercise-description/index.md Outdated Show resolved Hide resolved
nl/references/exercise-description/index.md Outdated Show resolved Hide resolved
en/references/exercise-description/index.md Show resolved Hide resolved
nl/faq/activities/index.md Outdated Show resolved Hide resolved
nl/faq/activities/index.md Outdated Show resolved Hide resolved
nl/guides/exercises/examples/command-line/index.md Outdated Show resolved Hide resolved
nl/guides/exercises/examples/input-output/index.md Outdated Show resolved Hide resolved
@BTWS2 BTWS2 requested review from niknetniko and jorg-vr January 11, 2024 16:34
nl/faq/activities/index.md Outdated Show resolved Hide resolved
nl/faq/index.md Outdated Show resolved Hide resolved
nl/references/exercise-description/index.md Outdated Show resolved Hide resolved
@BTWS2 BTWS2 requested a review from niknetniko January 18, 2024 10:17
Copy link
Member

@bmesuere bmesuere left a comment

Choose a reason for hiding this comment

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

Thank you for your changes! I left a few comments below and inline.


I'm not convinced that we need an FAQ question about courses vs repositories. In my opinion, adding the question makes things more complicated than they are and may add confusion. A teacher that starts to use Dodona should only know the course concept. More advanced users learn what a repository is. Our new manual does a good job in explaining this.


I added few comments. Those on the English pages also apply to the Dutch translations.


In the future, try to make smaller PRs that only add/change a single thing. This makes it a lot easier to review and will speed things up significantly.

en/references/exercise-description/index.md Outdated Show resolved Hide resolved
en/references/exercise-description/index.md Outdated Show resolved Hide resolved
en/references/judges/index.md Outdated Show resolved Hide resolved
@@ -0,0 +1,189 @@
---
title: "Oefeningen opstellen: leesactiviteit"
Copy link
Member

Choose a reason for hiding this comment

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

I agree with Niko here. This fits best in the "soorten oefeningen" section.

nl/guides/exercises/examples/_common.md Outdated Show resolved Hide resolved
nl/guides/exercises/examples/class/index.md Outdated Show resolved Hide resolved
@BTWS2 BTWS2 requested a review from bmesuere January 22, 2024 18:59
@jorg-vr jorg-vr merged commit 00d5a71 into dodona-edu:main Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add guide for reading activities Add FAQ: repository vs course
5 participants