Skip to content

ci: pin docs-engine to v0.4.1 for doc search - #9

Merged
burinc merged 1 commit into
jlt-commons:mainfrom
burinc:ci/bump-docs-engine-v0.4.1
Oct 5, 2026
Merged

burinc merged 1 commit into
jlt-commons:mainfrom
burinc:ci/bump-docs-engine-v0.4.1

Conversation

@burinc

@burinc burinc commented Oct 5, 2026

Copy link
Copy Markdown
Member

What

Moves this project's site build from docs-engine v0.3.0 to v0.4.1. The pin
in .github/workflows/site.yml is the only change.

Why

v0.4.1 adds client-side search to every generated site. A magnifier in the
nav (or /) opens it, and results jump to the matching section of a guide
page, opening a collapsed section if the hit is inside one. The engine writes
a search-documents.json index at build time, and lunr.js plus the index
load only when a reader first opens search, so a reader who never searches
downloads neither. A project can turn it off with :search false in
docs/site.edn.

It also picks up the two releases this repo skipped: v0.3.1 (shareable
heading anchors) and v0.3.2 (jolt run build/clean fix, docs-engine#3).

Verification

Built locally with jolt run build against docs-engine v0.4.1, on a tree
identical to this branch apart from the pin:

  • the build completed and wrote a 32-record search index, every href under /ebb/
  • docs/check-site.sh passed ("index, guide overview, evaluation, conformance and the ADR all present, every URL under /ebb")

CI on this PR is the authoritative check.

Prior art

@burinc
burinc merged commit 6b9dc39 into jlt-commons:main Oct 5, 2026
3 checks passed
@burinc
burinc deleted the ci/bump-docs-engine-v0.4.1 branch October 5, 2026 10:57
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