Development: Update programming exercise ICL docs

[BBesrour]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

Added a section about editing the checkout paths

Steps for Testing

Make sure that docs are correct and comprehensible

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Code Review

• Code Review 1
• Code Review 2

Test Coverage

Screenshots

Summary by CodeRabbit

• New Features

  • Introduced a validation bar for improved navigation during programming exercise setup.
  • Added sections for editing repository checkout paths, configuring static code analysis, and verifying exercise configurations.

• Documentation

  • Enhanced clarity and usability of the programming exercise setup guide with additional notes and warnings.
  • Removed specific version constraints for Sphinx-related packages to allow for the latest updates.

[coderabbitai]

Walkthrough

The changes in this pull request involve updates to the requirements.txt file and the programming-exercise-setup.inc documentation. The requirements.txt file has had version specifications removed for several Sphinx-related packages, allowing for the use of the latest versions. The documentation file has been significantly revised to improve clarity and usability, including the addition of new sections related to repository checkout paths, static code analysis configuration, and exercise verification.

Changes

File	Change Summary
docs/requirements.txt	Removed version specifications for Sphinx, sphinx-rtd-theme, sphinx-autobuild, and sphinxcontrib-bibtex.
docs/user/exercises/programming-exercise-setup.inc	Added new sections: Edit Repositories Checkout Paths, Configure Static Code Analysis, and Verify the exercise configuration. Expanded existing content for clarity and usability.

Possibly related PRs

• Development: Document DejaGnu blackbox tests #8680: This PR documents the features of programming exercises, including updates to the programming-exercise-features.inc file, which may relate to the overall documentation structure that includes requirements.txt changes.
• Development: Document the manual assessment of programming exercises #8968: This PR adds a section on manual assessment in programming exercises, which could be relevant as it also deals with documentation related to programming exercises.
• Integrated code lifecycle: Configure checkout path and timeout for programming exercises #9217: Although this PR focuses on configuring checkout paths and timeouts for programming exercises, it may indirectly relate to the overall setup and requirements for programming exercises, similar to the changes in requirements.txt.
• Programming exercises: Do not always show the request feedback button in the online code editor #9475: This PR modifies the visibility of the request feedback button in the online code editor, which is part of the user interface for programming exercises, aligning with the documentation changes in the main PR.

Suggested labels

ready for review, config-change, small

Suggested reviewers

• krusche
• SimonEntholzer
• edkaya

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ee842c1 and a9cb464.

📒 Files selected for processing (1)

• docs/user/exercises/programming-exercise-setup.inc (3 hunks)

🧰 Additional context used

🔇 Additional comments (5)

docs/user/exercises/programming-exercise-setup.inc (5)

376-400: LGTM! New section provides clear instructions and important warnings.

The new section "Edit Repositories Checkout Paths" is well-structured and provides valuable information for users. The warnings about potential issues when changing checkout paths are particularly helpful.

---

Line range hint 402-477: Excellent improvements to the static code analysis configuration section!

The expanded "Configure static code analysis" section now provides a comprehensive overview of the configuration process. The additions include:

1. A detailed table showing supported static code analysis tools for each programming language.
2. Information about the execution mechanism and configuration files for each tool.
3. Clear instructions on how to disable specific tools if needed.

These improvements will greatly assist users in understanding and configuring static code analysis for their programming exercises.

---

Line range hint 730-765: Great addition of the template/solution comparison feature!

The updated "Verify the exercise configuration" section now includes a valuable new feature for comparing template and solution repositories. This addition will greatly assist instructors in reviewing the changes students are expected to make to solve the exercise. The improvements include:

1. Clear instructions on how to access the comparison feature.
2. Helpful screenshots illustrating the comparison view and how to access it.
3. Integration of this new feature into the existing verification process.

These updates enhance the overall exercise configuration verification process and provide instructors with a powerful tool for ensuring exercise quality.

---

Line range hint 1-765: Excellent improvements to the programming exercise setup documentation!

The changes made to this file significantly enhance the quality and comprehensiveness of the documentation for setting up programming exercises in Artemis. Key improvements include:

1. Addition of a new section on editing repository checkout paths, providing clear instructions and important warnings.
2. Expansion of the static code analysis configuration section, offering a detailed overview of supported tools and configuration options.
3. Introduction of a new feature for comparing template and solution repositories, complete with visual guidance.

These updates will greatly assist instructors and users in creating, configuring, and verifying programming exercises. The documentation is now more thorough, user-friendly, and aligned with the latest features of the Artemis system.

---

379-380: ⚠️ Potential issue

Fix the syntax of the :ref: directive

The reStructuredText cross-reference directive should use single backticks.

Apply this diff to correct the syntax:

-**This option is only available when using** :ref:``integrated code lifecycle``
+**This option is only available when using** :ref:`integrated code lifecycle`

Likely invalid or redundant comment.

---

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 or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (2)

docs/user/exercises/programming-exercise-setup.inc (2)

397-397: Correct the capitalization of 'OCaml'

The programming language 'OCaml' should be correctly capitalized to maintain consistency.

Apply this diff:

-For example, for Java exercises, only the assignment repository path can be changed. For Ocaml exercises, the assignment, test, and solution repository paths can be changed.
+For example, for Java exercises, only the assignment repository path can be changed. For OCaml exercises, the assignment, test, and solution repository paths can be changed.

---

399-399: Capitalize 'Docker' appropriately

'Docker' is a proper noun and should be capitalized.

Apply this diff:

-For C programming exercises, if used with the default docker image, changing the checkout paths will lead to build errors. The default docker image is configured to work with the default checkout paths.
+For C programming exercises, if used with the default Docker image, changing the checkout paths will lead to build errors. The default Docker image is configured to work with the default checkout paths.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 98d6d06 and ee842c1.

⛔ Files ignored due to path filters (2)

• docs/user/exercises/programming/checkout-paths-edit.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/checkout-paths-preview.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (2)

• docs/requirements.txt (1 hunks)
• docs/user/exercises/programming-exercise-setup.inc (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/requirements.txt

🧰 Additional context used