docs(agents): check documentation before opening a pull request

[jamesbhobbs]

Adds a Documentation section to CLAUDE.md: check whether a change makes documentation stale before opening a PR, with the places it lives — docs/user/, docs/dev/, README.md, CONTRIBUTING.md, and, for anything a Deepnote user sees, docs/ in the public deepnote repository, published at https://deepnote.com/docs.

Part of a small pass applying the same rule across the Deepnote repos.

The Pull Requests section this PR originally also added has been dropped per review (#discussion_r4092320040), matching the same call on deepnote/tf-infra#493.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Added contributor guidance to check for outdated documentation before opening a pull request and update affected documentation in the same pull request.
  • Identified relevant documentation locations and clarified that user-facing Deepnote Cloud documentation is maintained in the public Deepnote repository, where related changes should be submitted separately.
  • Recommended updating only documentation affected by the change.

[linear-code]

BLU-5873

[coderabbitai]

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Essentials
• Run ID: 49aaf9b9-4ecf-4082-a8a5-7dea1beeb754

📥 Commits

Reviewing files that changed from the base of the PR and between 37a2e1f and 55d8e59.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

• Configuration used: Organization UI
• Review profile: CHILL
• Plan: Essentials
• Run ID: e851a02d-8a5d-4fee-8fe5-15f50afcd256

📥 Commits

Reviewing files that changed from the base of the PR and between 5d458b8 and 37a2e1f.

📒 Files selected for processing (1)

• CLAUDE.md

💤 Files with no reviewable changes (1)

• CLAUDE.md

Included review availability: This review used your included allowance. 4 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

---

📝 Walkthrough

Walkthrough

Added guidance in CLAUDE.md to check for stale documentation and update documentation affected by a change. It lists repository documentation locations and directs contributors to open a matching pull request in the public deepnote repository when changes affect what Deepnote users see.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 37a2e

This change adds contributor documentation guidance only and does not alter product behavior. It is safe to merge.

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Updates Docs	✅ Passed	No feature is implemented in this pull request. The only changed file is CLAUDE.md, which adds documentation guidance. The external OSS documentation and private roadmap are therefore not triggered …
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: adding guidance to check and update documentation before opening a pull request.

---

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

[github-actions]

📦 Python package built successfully!

• Version: 2.8.0.dev6+f738889
• Wheel: deepnote_toolkit-2.8.0.dev6+f738889-py3-none-any.whl
• Install:

  pip install "deepnote-toolkit @ https://deepnote-staging-runtime-artifactory.s3.amazonaws.com/deepnote-toolkit-packages/2.8.0.dev6%2Bf738889/deepnote_toolkit-2.8.0.dev6%2Bf738889-py3-none-any.whl"

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.09%. Comparing base (4fa893b) to head (55d8e59).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #130      +/-   ##
==========================================
- Coverage   77.26%   77.09%   -0.17%     
==========================================
  Files         115      115              
  Lines        6589     6589              
  Branches      961      961              
==========================================
- Hits         5091     5080      -11     
- Misses       1186     1198      +12     
+ Partials      312      311       -1     

Flag	Coverage Δ
combined	77.09% <ø> (-0.17%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

[deepnote-bot]

🚀 Review App Deployment Started

📝 Description	🌐 Link / Info
🌍 Review application	ra-130
🔑 Sign-in URL	Click to sign-in
📊 Application logs	View logs
🔄 Actions	Click to redeploy
🚀 ArgoCD deployment	View deployment
⏰ Last deployed	2026-10-08 10:29:33 (UTC)
📜 Deployed commit	651d7b2c965e8a88e7b5aeabf81bcffd682134d3
🛠️ Toolkit version	f738889