Skip to content

docs: check documentation and keep PRs focused in CLAUDE.md - #27

Merged
tkislan merged 1 commit into
mainfrom
jh/agents-docs-check
Sep 23, 2026
Merged

tkislan merged 1 commit into
mainfrom
jh/agents-docs-check

Conversation

@jamesbhobbs

@jamesbhobbs jamesbhobbs commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

Adds two short sections to CLAUDE.md:

  • Documentation — check whether a change makes documentation stale before opening a PR: docs/source/, the crate READMEs, and rustdoc on the public API.
  • Pull Requests — keep each PR as simple and clean as possible, avoiding unrelated reformatting of upstream code so future upstream merges stay easy.

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added guidance for maintaining affected documentation, READMEs, and public API comments.
    • Added pull request guidance encouraging focused changes and avoiding unrelated refactoring or reformatting.

Ask agents to update docs/source, the READMEs, and rustdoc alongside a
behavior change, and to keep each PR small so upstream merges stay easy.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

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: 24ff0edd-14af-4163-ac1b-084cc745032a

📥 Commits

Reviewing files that changed from the base of the PR and between 3c998e7 and 6097bc8.

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

Included review availability: 0 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

CLAUDE.md now guides updates to affected documentation, README files, and public Rustdoc comments. It also advises contributors to keep pull requests focused and avoid unrelated refactoring or reformatting. The guidance applies to fork-specific behavior.

Priority: ⬇️ Low

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

Change: Other

🚥 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 summarizes both main changes: documentation guidance and focused pull-request guidance in CLAUDE.md.
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 PASS — The reviewed range changes only CLAUDE.md and contains no feature implementation. The new guidance covers docs/source/, crate READMEs, and public Rustdoc. No OSS feature documentation or ro…

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.

@tkislan
tkislan merged commit 56a1529 into main Sep 23, 2026
10 checks passed
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