Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesbhobbs merged 3 commits into from
Oct 8, 2026
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5d458b8
docs(agents): check documentation and keep PRs focused
jamesbhobbs Sep 21, 2026
37a2e1f
docs(agents): drop the Pull Requests section
jamesbhobbs Oct 8, 2026
55d8e59
Merge branch 'main' into jh/agents-docs-check
jamesbhobbs Oct 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,15 @@ You can run a single test using the following format:
```sh
TEST_TYPE="unit" TOOLKIT_VERSION="local-build" ./bin/test tests/unit/test_sql_execution.py::TestExecuteSql::test_execute_sql_with_connection_json_with_snowflake_encrypted_private_key
```

## Documentation

Before opening a pull request, check whether the change makes any documentation stale, and update it in the same pull request:

- `docs/user/` - user-facing toolkit configuration and behavior
- `docs/dev/` - development and internal configuration
- `README.md` - features, installation, and supported versions
- `CONTRIBUTING.md` - contributor and release workflow
- Product documentation for Deepnote Cloud is not in this repository: it lives as Markdown under `docs/` in the public [`deepnote`](https://github.com/deepnote/deepnote) repository and is published at https://deepnote.com/docs. A change that alters what a Deepnote user sees (SQL behavior, integrations, pre-installed packages, supported Python versions) needs a matching pull request there.

Update only the documentation your change actually affects.
Loading