Repository navigation
docs: lead with the package choice, drop arcadedb-native and unmeasured start-up numbers, state what happens to the old names - #85
Merged
Conversation
…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]>
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.
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
arcadedb". The install page and the quickstart say the same. The README intro no longer describesarcadedbas "a sibling" ofarcadedb-jvm; it states the two packages side by side.arcadedbandarcadedb-jvmat 0.0.1 only. Both placeholders install the oldarcadedb-embedded(checked with the PyPI JSON API). A plainpip install arcadedbtherefore does not give the new package, even after26.11.1.dev0exists, because pip skips pre-releases. The transition notes (README, start page, install page, Which package?, quickstart) now say so, next to the--preadvice. They carry the existingREMOVE WHENmarker.arcadedb-nativeis 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.arcadedb-embeddedrelease is a shim that installsarcadedb, the native build, so the runtime changes for those users andarcadedb-jvmis the way to keep the JVM;arcadedb-embedded-nativeis archived on PyPI, no shim. Changed in the Which package? table, the install-page note, the README and the PyPI description ofarcadedb(native/wheel/README.md).arcadedb-jvmwheel" (no such wheel exists yet). It says the JVM build 26.10.2.post1 (formerlyarcadedb-embedded).Overlap with the sibling PRs
Checked with trial merges of
main+ this branch with #83 and with #84, separately and together: no conflicts.Python versions/Platformsrows. I did not touch them, including the start page's own Requirements bullets, which duplicate the install page; fold them into one after native: build the Linux wheels in manylinux_2_28, test Python 3.15, document platforms #83 lands.[[migrate]]section. I left one sentence in place on purpose, because editing it conflicts with docs: limits of the native build, garbage collector row, migration steps #84: after docs: limits of the native build, garbage collector row, migration steps #84 merges, the sentence "The old packages will get a deprecation shim that points to the new names." under[[migrate]]should go. The Old names table above it now says it precisely:arcadedb-embeddedgets a shim that installsarcadedb, andarcadedb-embedded-nativeis archived with no shim. docs: limits of the native build, garbage collector row, migration steps #84's step 2 ("pip install arcadedb-jvmif you usedarcadedb-embedded") is right for people who want the same build; the shim is for those who do not act.Left as is, scheduled
pyproject.tomlDocumentation,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 whenhttps://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, andscripts/check_no_embedded_name.pyallows it on purpose.how-to/concurrency.adocandhow-to/bulk-loads.adockeep their numbers: each states its probe date and setup, or theab.py --noisemethod.Checks
npx -y [email protected] --failure-level WARN -o /dev/nullon index, installation, quickstart and which-package: clean.python3 scripts/check_no_embedded_name.py: clean.🤖 Generated with Claude Code