Repository navigation
Docs: fix the drift found by the weekly audit (PQ retrain, wheel size, broken fragment links, test and version instructions, CI descriptions) - #366
Merged
Conversation
Bindings docs: the PRODUCT codebook is kept across graph rebuilds since 26.11.1 (ArcadeData/arcadedb#10847, settings and defaults read from GlobalConfiguration.java at tag 26.11.1); native wheel size is about 66 MB (PyPI JSON, manylinux_2_28_x86_64 of 26.11.1.post2); five fragment links now use the ids Antora generates (idprefix '', idseparator '-'), and the result-set link uses its explicit anchor result-set-single-pass (also in dataframes-and-columns.adoc); the 26.11.1.devN sentence in bulk-loads.adoc is gone (no such pre-release is on PyPI). Development docs: README, CONTRIBUTING, tests/README, examples/README, ci.adoc and release.adoc now match the workflows and scripts (test commands, native build home, SNAPSHOT rule of a release run, native path filter, push and nightly gating, the native examples job, assign-maintainer.yml, JVM crash artifacts, workflow display names, ARCADEDB_TAG example 26.12.1-SNAPSHOT from scripts/dev_engine_pin.json, NATIVE_NOT_APPLICABLE and WINDOWS_NOT_APPLICABLE, install commands with uv). The native path list in ci.adoc uses +...+ so that ** no longer renders as bold. Docs and markdown only; no code, script or workflow file changed. 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.
Refs #365. I fixed the drift that the weekly audit of the bindings docs and the development and testing docs found and that a text edit can fix. The rest is listed on the issue.
vectors.adoc: the statement that every PRODUCT graph rebuild retrains the codebook is replaced by the 26.11.1 behavior: the codebook is kept and retrained pastarcadedb.vectorIndex.pqRetrainGrowthFactororpqRetrainErrorRatio, with the defaults read from the engine source of the 26.11.1 tag.installation.adoc: the native wheel size is stated from the PyPI file size.dataframes-and-columns.adocis fixed the same way.README.md,CONTRIBUTING.md,tests/README.mdandexamples/README.md: the test command is theuv run --no-project --with ... python -m pytestform the repository uses, the version strings followscripts/dev_engine_pin.json, and the commands useuv.ci.adoc,release.adocand the issue and pull request templates: the path lists, job descriptions, display names and the SNAPSHOT statement match the workflows.The docs build (the command of "Build docs site") exits 0 with no warnings, all the fragment links of the docs resolve against the built site, and the added lines have no em dashes and no
pip install.🤖 Generated with Claude Code