chore: move example scripts from docs/examples/ to examples/#1573
Conversation
The runnable example scripts are Python programs, not documentation, so move them to the repository-root examples/ directory (alongside the existing refresh_browser_cookies.py) and update every reference: - tests/_guardrails/test_docs_examples_idioms.py: repoint EXAMPLES_DIR to examples/ (the idiom guard now also covers refresh_browser_cookies.py) - AGENTS.md: examples now live at examples/ - CONTRIBUTING.md: drop examples/ from the docs/ tree, note the root location - docs/releasing.md: py_compile examples/*.py Pure git mv -- no change to the scripts themselves. Verified: py_compile, ruff, the copy-paste idiom guard, and the docs guardrails all pass. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (10)
📝 WalkthroughWalkthroughAll references to ChangesExamples directory path update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Code Review
This pull request moves the runnable example scripts from docs/examples/ to the repository root under examples/. Documentation files and guardrail tests have been updated to reflect this path change. No review comments were provided, and there is no feedback to address.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
What
Moves the runnable example scripts from
docs/examples/to the repository-rootexamples/directory (alongside the existingrefresh_browser_cookies.py). They're Python programs, not documentation, so the repo root is the more natural home.Files
Moved (pure
git mv, no content change):bulk-import.py,chat.py,notes.py,quickstart.py,research-to-podcast.py,video.pyReferences updated:
tests/_guardrails/test_docs_examples_idioms.pyEXAMPLES_DIRrepointed toexamples/(the copy-paste idiom guard now also coversrefresh_browser_cookies.py)AGENTS.mdexamples/CONTRIBUTING.mdexamples/from thedocs/tree; noted the root locationdocs/releasing.mdpy_compile examples/*.pyVerification
rg "docs/examples"→ no references remain anywherepython -m py_compile examples/*.py✅ruff check+ruff format --checkonexamples/✅pytest tests/_guardrails/test_docs_examples_idioms.py✅ (now globsexamples/)check_docs_module_refs.py✅ ·check_claude_md_freshness.py✅🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Tests