Skip to content

Add comprehension question user guide - #38

Merged
drek2991 merged 1 commit into
mainfrom
derek-user-guide
Oct 9, 2026
Merged

drek2991 merged 1 commit into
mainfrom
derek-user-guide

Conversation

@drek2991

@drek2991 drek2991 commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Issue for this PR

Closes #

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Updated UserGuide.md with documentation for my part of Learn Mode: comprehension question context extraction, generation, and handoff.

The guide explains how users encounter and answer comprehension questions before edits are applied. It also includes a manual walkthrough for testing successful answers, failed answers, retries, and rejected changes.

I also documented the relevant automated tests and corrected an outdated test file path in the queue/steer section.

How did you verify your code works?

Reviewed the documentation against the implemented Learn Mode behavior and existing tests. Added step-by-step manual verification instructions and commands for running the relevant tests.

Screenshots / recordings

N/A — documentation-only change.

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

@drek2991
drek2991 merged commit 31114b4 into main Oct 9, 2026
6 checks passed
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.

1 participant