Skip to content

[Docs] Enhance Documentation: Add Quiz Part for Academy Course in new page #730

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

Merged
merged 25 commits into from
Aug 5, 2025

Conversation

Vincamine
Copy link
Contributor

Notes for Reviewers

This PR fixes #729

Signed commits

  • Yes, I signed my commits.

Copy link

netlify bot commented Jul 31, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit d40c5b8
🔍 Latest deploy log https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/68922c0154cc6800082a2155
😎 Deploy Preview https://deploy-preview-730--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@Vincamine
Copy link
Contributor Author

Vincamine commented Aug 1, 2025

Update:
1.added key rules:
1.1 Each level can have a quiz.md file, and passing the quiz marks that level as completed.(with examples)
1.2 Quizzes can have prerequisites that must be completed before taking the quiz.
1.3. add Quiz Quantity Per Level rules
1.4 Unified Quiz Structure

2.adjusted other related part.
3.added the part link for (page, quiz and lab)

4.(lin231) remove the reference link
5.For the number of tests required in different level(1 must have), added an alert as reminder.

Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@Vincamine
Copy link
Contributor Author

The title and first paragraph need to chaneg. We can add quizzes at all levels of content hierarchy, so those sections will need to be updated accordingly.

Also, if we're not planning to immediately write about "page" and "lab" types, the title should simply be "Creating Quizzes", and the content should focus solely on quizzes.

creating "pages" looks like a necessity? I'll use more quizzes-focused title.

@Namanv0509
Copy link
Member

also quiz id doesnt need a uuid , it can be a normal id like id: contrainers

@zihanKuang
Copy link
Contributor

It would be great if you could include a screenshot of a quiz to show what it looks like.

Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@zihanKuang
Copy link
Contributor

also quiz id doesnt need a uuid , it can be a normal id like id: contrainers

Yes, if you declare an id, it will be a normal ID. If you don't declare one, we'll automatically generate a UUID for it.

Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@leecalcote
Copy link
Member

My, my, my, don't you have a popular PR, @Vincamine? 😄

@Vincamine
Copy link
Contributor Author

My, my, my, don't you have a popular PR, @Vincamine? 😄

Haha, a spicy one for sure. Got it covered!

Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@Vincamine Vincamine requested review from leecalcote, l5io, ShashaankS and zihanKuang and removed request for vr-varad and ShashaankS August 4, 2025 00:31
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
Signed-off-by: Zihan Kuang <127078886+zihanKuang@users.noreply.github.com>
Vincamine and others added 3 commits August 5, 2025 00:00
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
@vr-varad vr-varad merged commit 42508ea into layer5io:master Aug 5, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Enhance Documentation: Guidelines for Academy Course Activities: Quiz
8 participants