Skip to content

docs: 'Which package for which mode' page; link the main docs instead of re-explaining - #25

Merged
tae898 merged 2 commits into
mainfrom
docs/packages-and-postgres-sqlite-pages
Oct 24, 2026
Merged

tae898 merged 2 commits into
mainfrom
docs/packages-and-postgres-sqlite-pages

Conversation

@tae898

@tae898 tae898 commented Oct 23, 2026 •

Copy link
Copy Markdown
Collaborator

What

Based on docs/antora-component (#23, still open); merge after #23, or retarget to main once it lands. Scope rule applied: these docs cover only what is specific to the Python bindings and link the main ArcadeDB docs for everything else.

  • New page docs/modules/ROOT/pages/packages.adoc, "Which package for which mode". The embedded packages (arcadedb-embedded JVM build, arcadedb-embedded-native preview, and the names they move to in mid-November: arcadedb, arcadedb-native, arcadedb-jvm) with the rule of thumb: short-lived and footprint-sensitive processes use native, long-lived processes with heavy repeated scans or big loads use the JVM build, several processes or services sharing one database use the server. One line each for arcadedb-driver and arcadedb-driver-grpc with xrefs to the main docs' Python HTTP and gRPC driver pages, and one line for the unrelated community arcadedb-python (stevereiner), which shares this repository's name. The page links the index sections on embedded vs HTTP and JVM vs native instead of repeating them. PyPI facts checked on 2026-10-24.
  • No "Coming from Postgres or SQLite" page: the main docs already cover it. The quickstart gets one sentence (ArcadeDB SQL is its own dialect without JOINs) linking arcadedb::reference/sql/sql-introduction.adoc#no-joins, and the how-to gets one Python-specific NOTE (SQLAlchemy, other ORMs and tools that generate JOIN queries do not work with db.query/db.command).
  • Scope trims of docs: Antora component arcadedb-python with the first slice of pages #23's pages, kept here so docs: Antora component arcadedb-python with the first slice of pages #23 stays as reviewed: the how-to's "Parameters" lost the SQL-injection and statement-cache explanation, "SQLScript" and "openCypher" now link the main docs' SQLScript and openCypher references, and the index gets an anchor (jvm-vs-native) to link to. The quickstart, installation and index pages are otherwise Python-specific and unchanged.
  • docs/antora.yml gets short-pkg-name, short-native-pkg-name, jvm-pkg-name, driver-pkg-name, grpc-driver-pkg-name, community-driver-pkg-name and community-repo-url, so the November renames are a one-place edit. nav.adoc lists the packages page.

Checked locally

Antora build with the main ArcadeDB docs (arcadedb-docs, branch docs/arcadedb-python-component) and this branch as sources: exit code 0, no warnings from this component, and the xrefs resolve to reference/sql/sql-introduction.html#no-joins, the Python HTTP and gRPC driver pages, the SQLScript and openCypher references. Only prose changed in the script pages, so their outputs (run against arcadedb-embedded 26.10.2.post1 earlier) are untouched.

🤖 Generated with Claude Code

tae898 and others added 2 commits October 24, 2026 02:33
… SQLite' pages

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…stead; trim the packages page and the how-to to Python specifics

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tae898 tae898 changed the title docs: 'Which package for which mode' and 'Coming from Postgres or SQLite' pages docs: 'Which package for which mode' page; link the main docs instead of re-explaining Oct 23, 2026
@tae898
tae898 changed the base branch from docs/antora-component to main October 24, 2026 15:47
@tae898
tae898 merged commit 77b3c93 into main Oct 24, 2026
46 checks passed
tae898 added a commit that referenced this pull request Oct 24, 2026
docs: concurrency, processes and crashes (measured), stacked on #25
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