Skip to content

docs: add Claude repository routing #461

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

Draft
jamesbhobbs wants to merge 1 commit into
base: main
Choose a base branch
from
+25 −85
Draft

docs: add Claude repository routing #461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 0 additions & 84 deletions AGENTS.md
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CLAUDE.md
1 change: 0 additions & 1 deletion CLAUDE.md
View file
Open in desktop

This file was deleted.

24 changes: 24 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Deepnote editor extension

This TypeScript repository implements the Deepnote notebook extension for VS Code-compatible editors and its integration with Deepnote's format and Python runtime.

## Working rules

- Use the routing table before searching. Start with the architecture, owning feature directory, and colocated tests; do not traverse unrelated inherited VS Code code.
- Read `package.json`, build configuration, and CI for current commands, versions, and tooling instead of copying them into guidance.
- Add or update focused tests for behavior changes and compare complete objects with `assert.deepStrictEqual` where practical.
- Use platform path APIs rather than constructing paths with separators. Store and dispose lifecycle resources, and validate expected state after asynchronous setup or before cached early returns.
- Do not add the Microsoft copyright header to new files. Follow nearby import and organization patterns rather than inventing new ones.
- Document non-obvious coupling at every affected serializer, controller, service, or webview with reciprocal references.
- Put durable discoveries in shared repository documentation under `specs/` or the nearest README, not local memory files. Keep this file limited to behavior and routing.

## Routing table

| When looking for | Look into |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| User-facing capabilities and repository overview | [README.md](README.md) |
| Development workflow, build targets, and test suites | [CONTRIBUTING.md](CONTRIBUTING.md), `package.json`, and `.github/workflows/` |
| Deepnote extension architecture and data flow | [specs/architecture.md](specs/architecture.md) |
| A specific feature or platform abstraction | The owning directory under `src/`, its nearest README, and colocated tests |
| Notebook format, conversion, and integration schemas | [deepnote](https://github.com/deepnote/deepnote) (`../deepnote` when available) |
| Kernel, Jupyter, SQL, and language-server runtime | [deepnote-toolkit](https://github.com/deepnote/deepnote-toolkit) (`../deepnote-toolkit` when available) |
Loading