Repository navigation
ci: pin docs-engine to v0.4.1 for doc search - #9
Merged
Merged
Conversation
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.
What
Moves this project's site build from docs-engine v0.3.0 to v0.4.1. The pin
in
.github/workflows/site.ymlis 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 guidepage, opening a collapsed section if the hit is inside one. The engine writes
a
search-documents.jsonindex at build time, and lunr.js plus the indexload only when a reader first opens search, so a reader who never searches
downloads neither. A project can turn it off with
:search falseindocs/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/cleanfix, docs-engine#3).Verification
Built locally with
jolt run buildagainst docs-engine v0.4.1, on a treeidentical to this branch apart from the pin:
/ebb/docs/check-site.shpassed ("index, guide overview, evaluation, conformance and the ADR all present, every URL under /ebb")CI on this PR is the authoritative check.
Prior art