Skip to content

docs: note Node.js and libsqlite3-dev as source-build prerequisites - #762

Merged
wesm merged 2 commits into
kenn-io:mainfrom
rodboev:pr/setup-prereqs
Sep 4, 2026
Merged

docs: note Node.js and libsqlite3-dev as source-build prerequisites#762
wesm merged 2 commits into
kenn-io:mainfrom
rodboev:pr/setup-prereqs

Conversation

@rodboev

@rodboev rodboev commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

The Build From Source docs list Go, Bun, and a C/C++ compiler, but a clean make install on Linux also needs Node.js and, on Debian/Ubuntu, libsqlite3-dev. Both are already provided by CI and the Dockerfile, so the gap is invisible in automation and only surfaces on a developer's own machine.

  • Add Node.js to the prerequisite lists in README.md, docs/setup.md, and docs/development.md. The floor is Node.js 20.19+ on 20.x, 22.13+ on 22.x, or 24+, matching the jsdom engines pulled in by the embed validator that make install runs.
  • Note libsqlite3-dev (Debian/Ubuntu) for the sqlite3.h header the default sqlite_vec build compiles against.
  • Add the sqlite3.h: No such file case to the CGO / Build Errors section in docs/troubleshooting.md.

Fixes #659.

@roborev-ci

roborev-ci Bot commented Sep 4, 2026

Copy link
Copy Markdown

roborev: Combined Review (ef26126)

No issues found.


Reviewers: 2 done | Synthesis: codex | Total: 1m31s

@wesm wesm assigned wesm and unassigned wesm Sep 4, 2026
The Make-based build needs Node and system SQLite headers, while the
Windows helper builds directly with Go and supplies its own header.
The prior blanket prerequisite list incorrectly told Windows users to
install tools that their supported build path does not run.

Generated with Codex
Co-authored-by: Codex <codex@openai.com>
@rodboev
rodboev marked this pull request as ready for review September 4, 2026 04:10
@roborev-ci

roborev-ci Bot commented Sep 4, 2026

Copy link
Copy Markdown

roborev: Combined Review (4b4cf10)

No issues found.


Reviewers: 2 done | Synthesis: codex | Total: 1m16s

@wesm
wesm merged commit 4921d44 into kenn-io:main Sep 4, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

docs: source-build prerequisites omit Node.js and libsqlite3-dev

2 participants