enhance(docs): improvements to reading flow, highlighting of important words, structural changes, reword for elements instead of questions

[rschlaefli]

started using https://docusaurus.io/docs/markdown-features/admonitions for improved highlighting of key topics

Summary by CodeRabbit

Release Notes

• New Features

  • Enhanced documentation for gamification, including a new "Goals of Gamification" section.
  • Introduction of terminology updates, replacing "Questions" with "Elements" to broaden interactive components.
  • Added a warning regarding the discontinuation of migration support from v2.0 to v3.0.

• Improvements

  • Improved clarity and structure across various documents, emphasizing key concepts with bold formatting.
  • Expanded sections on group activities and collaboration, detailing features like randomized group creation.

• Documentation Updates

  • Streamlined sidebar entries for better navigation, removing outdated sections.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (4)

• main
• master
• dev
• v3

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

📝 Walkthrough

Walkthrough

This pull request includes significant updates to various documentation files within the KlickerUZH application. Changes encompass renaming sections, enhancing clarity through bold formatting of key terms, and restructuring content for improved readability. Notable modifications involve the introduction of new sections on gamification goals, a shift in terminology from "questions" to "elements," and the addition of warning notices regarding migration support. The sidebar structure has also been streamlined by commenting out specific entries and sections.

Changes

File Path	Change Summary
apps/docs/docs/gamification/overview.mdx	Renamed section, added introductory notice, reformatted content, introduced "Goals of Gamification" section, expanded "Groups and Collaboration" section.
apps/docs/docs/getting_started/core_concepts.mdx	Updated terminology from "Questions" to "Elements," revised foundational component descriptions, enhanced Gamification section.
apps/docs/docs/getting_started/migration.mdx	Added warning notice about migration from v2.0 to v3.0 being unsupported.
apps/docs/docs/getting_started/welcome.mdx	Enhanced clarity with bold formatting of key terms, added new information boxes, restructured content for readability.
apps/docs/docs/student_tutorials/course_leaderboard.mdx	Bolded key terms, clarified leaderboard functionality, and refined lecturer roles.
apps/docs/docs/student_tutorials/groups_activities.mdx	Revised introductory section, added "randomized group creation" feature, emphasized key terms related to group activities.
apps/docs/docs/student_tutorials/klickeruzh_app.mdx	Enhanced clarity and emphasis on key terms, refined instructions for Android and iOS sections.
apps/docs/docs/student_tutorials/live_quiz.mdx	Bolded key terms, made minor grammatical corrections, no structural changes.
apps/docs/docs/student_tutorials/microlearning.mdx	Bolded key phrases, emphasized points awarded for correct answers.
apps/docs/docs/student_tutorials/practice_quiz.mdx	Emphasized key terms related to practice quizzes through bold formatting.
apps/docs/docs/student_tutorials/student_accounts.mdx	Bolded important concepts related to participant accounts and functionalities.
apps/docs/docs/tutorials/course_management.mdx	Enhanced clarity and readability through rephrasing and bold formatting of key terms.
apps/docs/docs/tutorials/element_management.mdx	Updated terminology from "questions" to "elements," revised management strategies for elements.
apps/docs/docs/tutorials/lti_integration.mdx	Changed title format, reformatted section headers for clarity, improved structure of integration instructions.
apps/docs/docs/tutorials/ppt_integration.mdx	Changed title, added informational note about integration with UZH MS365, clarified content structure.
apps/docs/docs/tutorials/supported_element_types.mdx	Restructured document with detailed descriptions of supported element types and added lecturer/student views.
apps/docs/sidebars.js	Removed specific entries from the sidebar, commented out sections to streamline documentation navigation.

Possibly related PRs

• enhance(apps/docs): extend documentation on randomized group creation, LTI integration and available element types #4255: Enhances documentation related to gamification and group activities, aligning with the main PR's focus.
• enhance(apps/frontend-manage): limit group activity creation to courses where group creation is enabled #4259: Limits group activity creation to courses where group creation is enabled, connecting to updates on group activities.
• feat: add possibility to extend microlearnings and group activities before end date #4283: Adds the ability to extend microlearnings and group activities, directly related to enhancing gamification features.
• enhance: improve live quiz list and show participants on completed quizzes #4284: Improves the live quiz list and shows participants on completed quizzes, relevant to updates on gamification and engagement features.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[rschlaefli]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

@rschlaefli: I will review the changes.

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[sjschlapbach]

LGTM