Skip to content

docs: lead with the package choice, drop arcadedb-native and unmeasured start-up numbers, state what happens to the old names - #85

Merged
tae898 merged 1 commit into
mainfrom
docs-cleanup-which-package
Oct 26, 2026
Merged

tae898 merged 1 commit into
mainfrom
docs-cleanup-which-package

Conversation

@tae898

@tae898 tae898 commented Oct 26, 2026

Copy link
Copy Markdown
Collaborator

Docs cleanup before the first pre-release, built on main. The docs set was already in good shape (11 pages, all in the nav, no orphans, the Python/embedded rule held: the HTTP driver, SQL, openCypher and transactions link to the main ArcadeDB docs by xref). This PR fixes what was left.

What changes

  • Which package is unmissable. The start page table now has an Install column and says "Not sure which one? Take arcadedb". The install page and the quickstart say the same. The README intro no longer describes arcadedb as "a sibling" of arcadedb-jvm; it states the two packages side by side.
  • Placeholder trap. PyPI shows arcadedb and arcadedb-jvm at 0.0.1 only. Both placeholders install the old arcadedb-embedded (checked with the PyPI JSON API). A plain pip install arcadedb therefore does not give the new package, even after 26.11.1.dev0 exists, because pip skips pre-releases. The transition notes (README, start page, install page, Which package?, quickstart) now say so, next to the --pre advice. They carry the existing REMOVE WHEN marker.
  • arcadedb-native is no longer documented. The name is reserved with no files and no publisher (MIGRATION decision, 2026-10-25). The "third name is planned" paragraph of Which package? and the README row are removed.
  • Old names say what really happens (humemai PR 512, decided 2026-10-25): the last arcadedb-embedded release is a shim that installs arcadedb, the native build, so the runtime changes for those users and arcadedb-jvm is the way to keep the JVM; arcadedb-embedded-native is archived on PyPI, no shim. Changed in the Which package? table, the install-page note, the README and the PyPI description of arcadedb (native/wheel/README.md).
  • Numbers without a measured source removed. The comparison table said native starts in "milliseconds" and the JVM in "about one second or more"; no measurement backs either. Both cells are qualitative now.
  • Quickstart no longer claims its output came from "the published arcadedb-jvm wheel" (no such wheel exists yet). It says the JVM build 26.10.2.post1 (formerly arcadedb-embedded).
  • Duplicated content. The start page's "Native build or JVM build" section repeated the Which package? table; it is now two sentences and a link.

Overlap with the sibling PRs

Checked with trial merges of main + this branch with #83 and with #84, separately and together: no conflicts.

Left as is, scheduled

  • pyproject.toml Documentation, examples/README.md (3 links), tests/README.md (2 links) and the README "Documentation" bullet point to docs.humem.ai, which answers 200 and is the only place for the guide and API reference today. They move when https://docs.arcadedb.com/arcadedb-python/ is live (it is 404 now; arcadedb-docs#505 is open), per the migration plan item A7.
  • docs/superpowers/ holds the plans of the repository move. It is not published, and scripts/check_no_embedded_name.py allows it on purpose.
  • how-to/concurrency.adoc and how-to/bulk-loads.adoc keep their numbers: each states its probe date and setup, or the ab.py --noise method.

Checks

  • npx -y [email protected] --failure-level WARN -o /dev/null on index, installation, quickstart and which-package: clean.
  • python3 scripts/check_no_embedded_name.py: clean.

🤖 Generated with Claude Code

…ed start-up numbers, state what happens to the old names

The start page, install page and quickstart say which package to take and that a plain pip install finds the 0.0.1 placeholder until a final 26.11.1 exists. The reserved arcadedb-native name is no longer documented. The start-up row of the comparison had no measured source and is now qualitative. The old-names text says what the arcadedb-embedded shim will do (install arcadedb, the native build) and that arcadedb-embedded-native is archived. The quickstart no longer claims the output came from a published arcadedb-jvm wheel.

Co-Authored-By: Claude Sonnet 5.5 <[email protected]>
@tae898
tae898 merged commit 3488da7 into main Oct 26, 2026
27 checks passed
@tae898
tae898 deleted the docs-cleanup-which-package branch October 26, 2026 02:30
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