Skip to content

Docs: embedded bindings or a driver? A chooser in the README and the docs - #302

Merged
tae898 merged 2 commits into
mainfrom
docs/driver-or-embedded
Nov 7, 2026
Merged

tae898 merged 2 commits into
mainfrom
docs/driver-or-embedded

Conversation

@tae898

@tae898 tae898 commented Nov 7, 2026

Copy link
Copy Markdown
Collaborator

People mix up the Python embedded bindings (arcadedb, arcadedb-jvm) and the official drivers (arcadedb-driver over HTTP, arcadedb-driver-grpc over gRPC), so I added a chooser. The index compared the bindings with the HTTP driver only, and the README had one sentence on the driver.

The README now has an "Embedded bindings or drivers?" block near the top: a 4-row table (what it is, needs a server, package and import name, use it when) with links to the HTTP and gRPC driver docs and to which-package.adoc. which-package.adoc has the full section "Embedded bindings or a driver?" with the same table, a three-line rule of thumb (including using both), a note that arcadedb is the embedded package and arcadedb-driver is the client, the gRPC plugin requirement, the Bolt, PostgreSQL, MongoDB and Redis note (standard clients, no ArcadeDB-specific one), and links to the driver pages of the main manual. The index and installation pages get one pointer sentence each, and the index section on the HTTP driver now mentions the gRPC driver.

This is prose and links only: no code block was added, so no docs page test changes, and there is no speed claim. I removed the old README paragraph on running the Docker image and arcadedb-driver because the new block covers it. I checked each docs.arcadedb.com and PyPI link target with curl -sI (all 200) and ran uvx pre-commit run --files on the four files (passes, including the old package name guard). The Docs workflow is the CI check for this change.

🤖 Generated with Claude Code

tae898 and others added 2 commits November 7, 2026 10:50
…docs

People mix up the Python embedded bindings (arcadedb, arcadedb-jvm) and the official drivers (arcadedb-driver over HTTP, arcadedb-driver-grpc over gRPC). The index already compared the bindings with the HTTP driver only, and the README had one sentence. Add one 4-row table (what it is, needs a server, package and import name, use it when) in the README and on which-package.adoc, where the full section also has the rule of thumb, the naming note (arcadedb is the embedded package, arcadedb-driver is the client), the gRPC plugin requirement, the Bolt/PostgreSQL/MongoDB/Redis note, and links to the driver pages of the main manual. The index and installation pages get one pointer sentence each. Prose and links only, no new behaviour claim, no speed claim.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ld README sentence named it)

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@tae898
tae898 merged commit 95c562e into main Nov 7, 2026
31 checks passed
@tae898
tae898 deleted the docs/driver-or-embedded branch November 7, 2026 02:30
@github-actions github-actions Bot added this to the 26.12.1 milestone Nov 7, 2026
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.

1 participant