Skip to content

chore: move example scripts from docs/examples/ to examples/#1573

Merged
teng-lin merged 1 commit into
mainfrom
chore/move-examples-to-root
Jun 14, 2026
Merged

chore: move example scripts from docs/examples/ to examples/#1573
teng-lin merged 1 commit into
mainfrom
chore/move-examples-to-root

Conversation

@teng-lin

@teng-lin teng-lin commented Jun 14, 2026

Copy link
Copy Markdown
Owner

What

Moves the runnable example scripts from docs/examples/ to the repository-root examples/ directory (alongside the existing refresh_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.py

References updated:

File Change
tests/_guardrails/test_docs_examples_idioms.py EXAMPLES_DIR repointed to examples/ (the copy-paste idiom guard now also covers refresh_browser_cookies.py)
AGENTS.md examples location → examples/
CONTRIBUTING.md dropped examples/ from the docs/ tree; noted the root location
docs/releasing.md py_compile examples/*.py

Verification

  • rg "docs/examples" → no references remain anywhere
  • python -m py_compile examples/*.py
  • ruff check + ruff format --check on examples/
  • pytest tests/_guardrails/test_docs_examples_idioms.py ✅ (now globs examples/)
  • check_docs_module_refs.py ✅ · check_claude_md_freshness.py

🤖 Generated with Claude Code

Review in cubic

Summary by CodeRabbit

  • Documentation

    • Updated project documentation, contributor guidelines, and release procedures to reflect reorganized example code structure.
  • Tests

    • Updated test validation to verify examples from new location.

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>
@coderabbitai

coderabbitai Bot commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f0b8e27f-2852-448f-89fd-fdfc67495c8b

📥 Commits

Reviewing files that changed from the base of the PR and between cec738f and 9f13bf1.

📒 Files selected for processing (10)
  • AGENTS.md
  • CONTRIBUTING.md
  • docs/releasing.md
  • examples/bulk-import.py
  • examples/chat.py
  • examples/notes.py
  • examples/quickstart.py
  • examples/research-to-podcast.py
  • examples/video.py
  • tests/_guardrails/test_docs_examples_idioms.py

📝 Walkthrough

Walkthrough

All references to docs/examples/ are updated to examples/ across AGENTS.md, CONTRIBUTING.md, docs/releasing.md, and the guardrail test test_docs_examples_idioms.py. CONTRIBUTING.md also reorganizes the documentation structure listing to place troubleshooting.md inside the docs/ tree and the examples/ note outside the directory block.

Changes

Examples directory path update

Layer / File(s) Summary
Update examples/ path across docs and guardrail test
AGENTS.md, CONTRIBUTING.md, docs/releasing.md, tests/_guardrails/test_docs_examples_idioms.py
Replaces docs/examples/ with examples/ in project structure notes, contributor guidance, release checklist compile command, and EXAMPLES_DIR constant used for test parametrization. CONTRIBUTING.md additionally moves troubleshooting.md inside the docs/ tree block and relocates the examples/ note after it.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Hop, hop, the path has moved,
No longer nested, nicely grooved,
docs/examples/ — gone away,
examples/ is here to stay!
The warren's tidy, hip-hooray! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and accurately summarizes the main change: moving example scripts from docs/examples/ to examples/.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/move-examples-to-root

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

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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@teng-lin teng-lin merged commit e29a227 into main Jun 14, 2026
27 checks passed
@teng-lin teng-lin deleted the chore/move-examples-to-root branch June 14, 2026 00:48
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.

2 participants