docs(agents): require a documentation check before opening a PR - #526
Conversation
Point agents at the docs that can go stale — `docs/` (published at deepnote.com/docs), package READMEs, and the repo-level guides — so a behavior change and its documentation land in the same pull request. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Understand this PR’s impact Explore downstream dependencies and potential security impact with Blast Radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughAGENTS.md now requires contributors to review affected product, package, skill, and repository workflow documentation before opening a pull request. The guidance limits documentation updates to pages directly affected by the code change. Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other Suggested reviewers: 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
Warning Some tools did not complete. Review the errors below. 🔧 LanguageToolLanguageTool 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #526 +/- ##
========================================
Coverage 89.86% 89.86%
========================================
Files 207 207
Lines 12200 12200
Branches 3514 3411 -103
========================================
Hits 10963 10963
Misses 1234 1234
Partials 3 3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
Not prod code, admin merging |
The branch was cut before #546/#547 raised the `undici` override to 6.28.1. The merge kept main's `undici@6.28.1` package entry alongside the `undici: 6.28.0` snapshot reference introduced with `@ai-sdk/provider-utils`, so `pnpm install --frozen-lockfile` failed with ERR_PNPM_LOCKFILE_MISSING_DEPENDENCY and took every CI job with it. Also document the agent providers in the runtime-core README, per the documentation check added in #526. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 participant
Adds a "Keeping Documentation in Sync" section to
AGENTS.md(inherited byCLAUDE.md) so agents check whether a change makes documentation stale before opening a PR, and know where each kind of documentation lives.Notably,
docs/in this repository is the source of truth for the product documentation published at https://deepnote.com/docs — including features built in other repositories — so that is called out explicitly.Part of a small pass applying the same rule across the Deepnote repos.
🤖 Generated with Claude Code
Summary by CodeRabbit