added clear assessments section

[LolaValente]

Summary by CodeRabbit

• Documentation
  • Improved formatting in the assessment authoring guide: corrected image alignment and alt-text presentation for clearer reading.
  • Added a "How to Clear Assessment Answers" section with step-by-step instructions and before/after visuals to help instructors manage responses.
  • Updated the Collapsible Content example delimiter in the Markdown authoring guide for more consistent rendering.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Adjusted image directive alignment and formatting in assessment authoring docs, added a "How to Clear Assessment Answers" section with before/after images, and changed the Collapsible Content example fence in the markdown guide to use a tilde-based delimiter.

Changes

Cohort / File(s)	Summary
Assessment authoring docs source/instructors/authoring/assessments/add-assessment.rst	Fixed indentation so the add_assessment.png image directive is left-aligned and alt text aligns; reformatted the Auto‑Graded Assessments reference line into a standard list item (includes LLM Rubric Autograde entry); added "How to Clear Assessment Answers" section with descriptive steps and clear_assessment_answers.png before/after images.
Markdown guide source/instructors/authoring/guides/markdown_content.rst	Replaced the Collapsible Content example block delimiter with a tilde-based fence (~~~~~~~) to delimit the example content.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation-only changes across two files; low logic risk.
• Areas to spot-check:
  • Render of updated image directives and existence/paths of add_assessment.png and clear_assessment_answers.png.
  • Consistent styling and grammar in the new "How to Clear Assessment Answers" section.
  • Proper rendering of the tilde-based example fence in the Collapsible Content section.

Possibly related PRs

• Splitagain #429 — Modifies add-assessment.rst and updates Auto‑Graded Assessments content; likely overlaps with formatting and list changes.
• assessment updates part 1 #428 — Edits the same add-assessment.rst file; may conflict with the new section or image directive adjustments.
• content editing update #439 — Alters markdown_content.rst Collapsible Content examples; potentially overlaps with the delimiter change.

Suggested reviewers

• shajason

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding a new 'How to Clear Assessment Answers' section to the documentation, which is the primary addition in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a21d04c and 29fb112.

⛔ Files ignored due to path filters (2)

• source/img/guides/clear_assessment_answers.png is excluded by !**/*.png, !**/*.png
• source/img/guides/clear_assessment_answersafter.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (1)

• source/instructors/authoring/assessments/add-assessment.rst (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rst

⚙️ CodeRabbit configuration file

**/*.rst: Review files for:

• Consistent formatting (e.g., headings, lists, links).
• Anywhere there are tables, they should use list-table.
• Clear and concise language.
• Correct grammar and spelling.
• Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
• Adherence to style guides (e.g., consistent tone, terminology).
  Suggest improvements to enhance readability and accessibility.
• Make sure to find all improvements on the first pass.
  Go through the material multiple times before submitting comments.

Files:

• source/instructors/authoring/assessments/add-assessment.rst

🧠 Learnings (1)

📚 Learning: 2025-10-27T17:55:37.142Z

Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.

Applied to files:

• source/instructors/authoring/assessments/add-assessment.rst

🔇 Additional comments (1)

source/instructors/authoring/assessments/add-assessment.rst (1)

74-74: New assessment type reference is properly formatted.

The LLM Rubric Autograde list item follows the established pattern and uses correct RST reference syntax.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7fb28d and d1c1cf8.

⛔ Files ignored due to path filters (1)

• source/img/guides/clear_assessment_answers.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (1)

• source/instructors/authoring/assessments/add-assessment.rst (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rst

⚙️ CodeRabbit configuration file

**/*.rst: Review files for:

• Consistent formatting (e.g., headings, lists, links).
• Anywhere there are tables, they should use list-table.
• Clear and concise language.
• Correct grammar and spelling.
• Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
• Adherence to style guides (e.g., consistent tone, terminology).
  Suggest improvements to enhance readability and accessibility.
• Make sure to find all improvements on the first pass.
  Go through the material multiple times before submitting comments.

Files:

• source/instructors/authoring/assessments/add-assessment.rst

🔇 Additional comments (1)

source/instructors/authoring/assessments/add-assessment.rst (1)

51-52: Image directive indentation is correct.

The indentation adjustment aligns the :alt: attribute properly under the .. image:: directive, following RST conventions.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d1c1cf8 and a21d04c.

📒 Files selected for processing (2)

• source/instructors/authoring/assessments/add-assessment.rst (2 hunks)
• source/instructors/authoring/guides/markdown_content.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**/*.rst

⚙️ CodeRabbit configuration file

**/*.rst: Review files for:

• Consistent formatting (e.g., headings, lists, links).
• Anywhere there are tables, they should use list-table.
• Clear and concise language.
• Correct grammar and spelling.
• Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
• Adherence to style guides (e.g., consistent tone, terminology).
  Suggest improvements to enhance readability and accessibility.
• Make sure to find all improvements on the first pass.
  Go through the material multiple times before submitting comments.

Files:

• source/instructors/authoring/assessments/add-assessment.rst
• source/instructors/authoring/guides/markdown_content.rst

🧠 Learnings (2)

📓 Common learnings

Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.

📚 Learning: 2025-10-27T17:55:37.142Z

Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.

Applied to files:

• source/instructors/authoring/assessments/add-assessment.rst

🔇 Additional comments (3)

source/instructors/authoring/guides/markdown_content.rst (1)

348-349: RST heading syntax is correct.

The tilde-based delimiter for the "Example" subsection follows proper RST convention with matching character count.

source/instructors/authoring/assessments/add-assessment.rst (2)

74-75: Reference syntax and formatting are correct.

The new LLM Rubric Autograde reference follows proper RST cross-reference syntax and maintains consistent formatting with the other assessment type entries.

---

77-83: RST syntax and formatting are correct.

The section follows proper RST conventions with correct heading underline length, appropriate paragraph formatting, and correct 3-space indentation for the image directive attribute. The descriptive content clearly explains the feature.

The image file source/img/guides/clear_assessment_answers.png exists in the repository and is properly referenced.