docs: update --debug references to --scenario-debug (#618)

[langwatch-agent]

Ticket

Closes #618. PR #551 hard-renamed the scenario debug pytest flag --debug -> --scenario-debug (no backward-compat alias, to stop colliding with pytest's built-in --debug), but the docs still showed the old flag. A user copy-pasting a documented pytest ... --debug command now silently invokes pytest's built-in flag instead of scenario debug mode.

Change

Update the five stale --debug references to --scenario-debug:

• README.md: the "passing the --debug flag to pytest" sentence and the pytest -s ... --debug example.
• docs/docs/pages/basics/debug-mode.mdx: the three pytest ... --debug -s examples.

Docs-only; the debug=True config field (a separate, still-valid API) is untouched.

Evidence

• Docs now match the CLI: python/scenario/pytest_plugin.py:251 registers --scenario-debug (its help text reads "Use --scenario-debug instead of --debug to avoid conflicting ..."), and there is no bare --debug scenario option in the plugin.
• No stale flag remains: grep -nE '\-\-debug\b' over README.md and debug-mode.mdx returns nothing (only --scenario-debug).

Advisory note

Advisory PR from the tech-debt-fixer bot, for human review, not to be merged by the bot. The human makes the merge call.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a147a715-0ec3-4af9-a900-47086c73edcd

📥 Commits

Reviewing files that changed from the base of the PR and between e675224 and 9644165.

📒 Files selected for processing (2)

• README.md
• docs/docs/pages/basics/debug-mode.mdx

---

Walkthrough

The documentation updates replace obsolete --debug pytest examples with --scenario-debug in the README and debug-mode guide.

Changes

Debug mode documentation

Layer / File(s)	Summary
Update debug command references README.md, docs/docs/pages/basics/debug-mode.mdx	All documented pytest commands for scenario debug mode now use --scenario-debug, including full-suite, targeted-test, and example-session commands.

Poem

A bunny hops through flags so bright,
--scenario-debug guides the night.
Old switches fade beyond the door,
Tests now show the steps once more.
Carrots cheer the docs galore!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the docs-only flag rename in the PR.
Description check	✅ Passed	The description directly explains the same documentation updates and rationale.
Linked Issues check	✅ Passed	The changes update the five stale --debug docs references to --scenario-debug as requested.
Out of Scope Changes check	✅ Passed	Only the documented flag references were changed; no unrelated edits are indicated.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch tech-debt-fixer-618

---

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.}

[github-actions]

Automated low-risk assessment

This PR was evaluated against the repository's Low-Risk Pull Requests procedure.

• Scope: Docs-only change: replace --debug with --scenario-debug in README.md and docs/pages/basics/debug-mode.mdx (update CLI examples and explanatory text).
• Exclusions confirmed: no changes to auth, security settings, database schema, business-critical logic, or external integrations.
• Classification: low-risk-change under the documented policy.

The changes are documentation-only: they update CLI flag references in README.md and the debug-mode docs to use --scenario-debug instead of --debug. No codepaths affecting authentication, secrets, database schemas, business logic, or external integrations are modified, so the PR meets the low-risk criteria.

An approving review has been submitted by automation. The PR may merge once required CI checks pass.

[github-actions]

Approved by automation: PR qualifies as low-risk-change under the documented policy.

[langwatch-agent]

No blocking findings. Reviewed current head 9644165eae37c1409c6c2ad0acda8865cc2fc086: the change is docs-only and updates the stale pytest CLI examples from --debug to --scenario-debug. I verified the registered pytest option in python/scenario/pytest_plugin.py is --scenario-debug, and the remaining --debug references are explanatory text/code/config rather than stale CLI examples.

CI is green for this head.