Skip to content

Docs drift found by the weekly audit of 2026-11-11: the text fixes are in a PR, re-runs and code changes are listed here #365

Open

Description

@tae898

The weekly audit of 2026-11-11 compared the bindings docs and the development and testing docs on main (2f3fb5d) with the code. Every command, script path, flag, workflow and job name they cite exists, and every API name and default matches src/arcadedb. It found drift in the text. The pull request linked below fixes the ones that are plain text: the PQ codebook statement in vectors.adoc (#10847 is fixed in 26.11.1), the wheel size in installation.adoc, five fragment links that did not resolve, the README.md instruction that ran the bare test command, the SNAPSHOT and dev0 version strings, the CI path lists and job descriptions in ci.adoc, and a few smaller items.

What a text edit cannot fix stays here:

  • Re-run quickstart.adoc and its output on the stable wheels (it names 26.10.2.post1).
  • Re-run the probe table of concurrency.adoc on 26.11.1.post2 (it covers older builds), or add a caveat.
  • Figures measured on 26.11.1.dev0 in which-package.adoc, vectors.adoc and installation.adoc: re-measure at the next pass.
  • facets.adoc and columnar-index.adoc require engine 26.12.1: check the older-engine section and add an install hint for the pre-release wheels.
  • Code and config: .pre-commit-config.yaml runs a local hook with system python3; the pyproject.toml comment points to a README section that does not exist; scripts/build.sh and native/wheel/build_wheel.py still use 26.11.1 examples.
  • bulk-loads.adoc: the pre-fix measurement of the #10746 section can be shortened now that the fix is in 26.11.1 (an editorial change).
  • ci.adoc: two more bullets with docs/** render as broken bold; wrap them the way the native-paths bullet was fixed.

Metadata

Metadata

Assignees

Labels

concurrencyThreads, transactions and conflictsdocumentationImprovements or additions to documentationgithub_actionsPull requests that update GitHub Actions codepythonPull requests that update python codevectorVector indexes and find_nearest

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions