Skip to content

docs(agents): check documentation and keep PRs focused - #130

Open
jamesbhobbs wants to merge 1 commit into
mainfrom
jh/agents-docs-check
Open

jamesbhobbs wants to merge 1 commit into
mainfrom
jh/agents-docs-check

Conversation

@jamesbhobbs

@jamesbhobbs jamesbhobbs commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Adds two short sections to CLAUDE.md:

  • Documentation — 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.
  • Pull Requests — keep each PR as simple and clean as possible.

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added contributor guidance to review and update affected documentation before opening pull requests.
    • Clarified that updates may include repository documentation, README content, contributing guidance, and relevant product documentation when user-visible behavior changes.
    • Recommended limiting documentation changes to content directly affected by the update.

Record which docs can go stale (docs/user, docs/dev, README, and the
product docs in deepnote/deepnote) so they are updated alongside the
change, and ask for small single-purpose pull requests.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jamesbhobbs
jamesbhobbs requested a review from a team as a code owner September 21, 2026 16:07
@linear-code

linear-code Bot commented Sep 21, 2026

Copy link
Copy Markdown

BLU-5873

@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

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: ca160b09-1bfd-4ab2-8ee8-8836f032e6fd

📥 Commits

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

📒 Files selected for processing (1)
  • CLAUDE.md

Included review availability: 2 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.


📝 Walkthrough

Walkthrough

Added a Documentation section to CLAUDE.md. The section requires contributors to check for stale documentation before opening pull requests. It covers repository documentation, README content, contributing guidance, and related Deepnote Cloud documentation when user-visible behavior changes. Updates must remain limited to affected documentation.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: mfranczel

🚥 Pre-merge checks | ✅ 6
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes both main changes: documentation checks and focused pull requests.
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 The pull request changes only CLAUDE.md (+17 lines) and adds documentation and PR-scope guidance. It implements no feature or user-visible behavior that requires documentation updates. The new guida…

Warning

Some tools did not complete. Review the errors below.

🔧 LanguageTool

LanguageTool checks were skipped: reviews.tools.languagetool.enabled_only requires at least one selection in enabled_rules or enabled_categories. Select rules/categories, set enabled_only to false to use the default rules, or set enabled to false to disable LanguageTool.


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

@github-actions

Copy link
Copy Markdown

📦 Python package built successfully!

  • Version: 2.7.0.dev2+4509991
  • Wheel: deepnote_toolkit-2.7.0.dev2+4509991-py3-none-any.whl
  • Install:
    pip install "deepnote-toolkit @ https://deepnote-staging-runtime-artifactory.s3.amazonaws.com/deepnote-toolkit-packages/2.7.0.dev2%2B4509991/deepnote_toolkit-2.7.0.dev2%2B4509991-py3-none-any.whl"

@codecov

codecov Bot commented Sep 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.71%. Comparing base (f2da6bb) to head (5d458b8).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #130   +/-   ##
=======================================
  Coverage   74.71%   74.71%           
=======================================
  Files          95       95           
  Lines        5754     5754           
  Branches      854      854           
=======================================
  Hits         4299     4299           
  Misses       1177     1177           
  Partials      278      278           
Flag Coverage Δ
combined 74.71% <ø> (ø)

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

Copy link
Copy Markdown

🚀 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-09-21 16:24:29 (UTC)
📜 Deployed commit e098e26605fba8f747eccb1db775fc78cef812d4
🛠️ Toolkit version 4509991

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