Repository navigation
Docs: embedded bindings or a driver? A chooser in the README and the docs - #302
Merged
Merged
Conversation
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
People mix up the Python embedded bindings (
arcadedb,arcadedb-jvm) and the official drivers (arcadedb-driverover HTTP,arcadedb-driver-grpcover 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.adochas the full section "Embedded bindings or a driver?" with the same table, a three-line rule of thumb (including using both), a note thatarcadedbis the embedded package andarcadedb-driveris 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-driverbecause the new block covers it. I checked each docs.arcadedb.com and PyPI link target withcurl -sI(all 200) and ranuvx pre-commit run --fileson the four files (passes, including the old package name guard). TheDocsworkflow is the CI check for this change.🤖 Generated with Claude Code