Skip to content

Update search docs to recommend Pagefind over Algolia - #359

Merged
nate-double-u merged 8 commits into
mainfrom
copilot/update-site-search-page
Aug 6, 2026
Merged

Update search docs to recommend Pagefind over Algolia#359
nate-double-u merged 8 commits into
mainfrom
copilot/update-site-search-page

Conversation

CopilotAI commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

The site search page still centered Algolia DocSearch and did not mention Pagefind. This updates the comparison to include Pagefind as the primary self-hosted static-site option and moves Algolia lower in the page.

  • Search options

    • Add a new Pagefind section with a short description and focused pros/cons
    • Keep DocSearch by Algolia, but move it behind Pagefind and Lunr in the page flow and TOC
  • Recommendation guidance

    • Update the "When Is It Best To Use One Over Another?" section to recommend Pagefind first for projects that want site search without a third-party service
    • Preserve Lunr as an alternative for teams that want a more custom in-browser implementation
  • Content refresh

    • Reframe Algolia tradeoffs around hosted indexing, plan limits, and reduced control relative to self-hosted approaches
-[Google search](#programmable-search-engine-by-google)-[Pagefind](#pagefind)-[Lunr](#lunr)-[DocSearch by Algolia](#docsearch-by-algolia)

CopilotAI linked an issue Jul 22, 2026 that may be closed by this pull request
CopilotAI changed the title [WIP] Update site search page to remove Algolia and add PageFindUpdate search docs to recommend Pagefind over AlgoliaJul 22, 2026
CopilotAI requested a review from nate-double-uJuly 22, 2026 17:17

@nate-double-unate-double-u left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot, let's add Pagefind to the .cspell.yml file, and review this comment from Claude:

Accuracy — the DocSearch "cost" con is misleading for a CNCF (all–open-source) audience.** The new con says "Free plans are limited, and larger indexes may require a paid plan." But DocSearch is free for technical-docs sites, which is exactly this audience — Algolia: "DocSearch is now free for all docs sites", DocSearch program docs. The real trade-offs for DocSearch specifically are: you must apply and be approved, and you must display the "Search by Algolia" logo (or pay to drop it). The PR's third con ("less control… than self-hosted") is accurate and worth keeping. Note this isn't a regression — the old text ("Not entirely free / 10k records") was arguably more wrong — but since you're touching it anyway, worth getting right.

@nate-double-unate-double-u left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot, another comment worth looking at from Claude:

Minor accuracy — "indexes your built site during your build process."** Pagefind runs as a post-build step against the already-built static output, not during the build. Small wording nit; the Cons ("requires a build step") are consistent. The rest of the Pagefind claims check out, including the on-demand/scales-better-than-in-browser pro, which is Pagefind's actual headline feature.

CopilotAI commented Jul 22, 2026

Copy link
Copy Markdown
ContributorAuthor

@copilot, let's add Pagefind to the .cspell.yml file, and review this comment from Claude:

Accuracy — the DocSearch "cost" con is misleading for a CNCF (all–open-source) audience.** The new co...

Fixed in 0d156a3. Added Pagefind to .cspell.yml and updated the DocSearch cons to cover approval for the free program, the required "Search by Algolia" logo, and the hosted/self-managed tradeoff.

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the TechDocs “Site Search” documentation to position Pagefind as the primary recommended self-hosted/static-site search option, while keeping Algolia DocSearch as a secondary (hosted) alternative.

Changes:

  • Adds a new Pagefind section with pros/cons and updates the page flow/TOC ordering.
  • Moves DocSearch by Algolia below Pagefind and Lunr, and refreshes its pros/cons to emphasize hosted tradeoffs.
  • Updates recommendation guidance to suggest Pagefind first for projects avoiding third-party services.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

FileDescription
docs/search.mdReorders and refreshes search provider guidance; introduces Pagefind and updates recommendations.
.cspell.ymlAdds “Pagefind” to the spelling allowlist for the updated docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/search.md

CopilotAI commented Jul 22, 2026

Copy link
Copy Markdown
ContributorAuthor

@copilot, another comment worth looking at from Claude:

Minor accuracy — "indexes your built site during your build process."** Pagefind runs as a post-build step against the already-built st...

Fixed in 25d3068. The Pagefind description now says it indexes the built site as a post-build step.

@nate-double-unate-double-u left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me, but @copilot, looks like you need to fix the file formatting as we have a prettier fail.

CopilotAI commented Jul 22, 2026

Copy link
Copy Markdown
ContributorAuthor

looks good to me, but @copilot, looks like you need to fix the file formatting as we have a prettier fail.

Fixed — Prettier reformatted a line wrap in the recommendation section. See the latest commit.

Comment threaddocs/search.md Outdated
Comment threaddocs/search.md Outdated

@nate-double-unate-double-u left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

good bot.

CopilotAIand others added 5 commits July 31, 2026 16:23
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
Signed-off-by: Nate W <natew@cncf.io>
@chalin
chalinforce-pushed the copilot/update-site-search-page branch from 840e80d to 431f801CompareJuly 31, 2026 20:23
@netlify

netlifyBot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for cncf-techdocs ready!

NameLink
🔨 Latest commit26cddeb
🔍 Latest deploy loghttps://app.netlify.com/projects/cncf-techdocs/deploys/6a74dd58bd703a0008cd364a
😎 Deploy Previewhttps://deploy-preview-359--cncf-techdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@chalinchalin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified the Pagefind claims against pagefind.app (post-build indexing, on-demand chunked index, zero-config multilingual) and the reworked DocSearch cons against the DocSearch program terms: all accurate. TOC and section order line up, and the deploy preview renders cleanly. Two optional suggestions inline, fine to leave as is.

Nice addition, LGTM!

Comment threaddocs/search.md Outdated
Comment threaddocs/search.md Outdated
nate-double-uand others added 2 commits August 6, 2026 12:15
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Signed-off-by: Nate W <natew@cncf.io>
@nate-double-u

Copy link
Copy Markdown
Member

Verified the Pagefind claims against pagefind.app (post-build indexing, on-demand chunked index, zero-config multilingual) and the reworked DocSearch cons against the DocSearch program terms: all accurate. TOC and section order line up, and the deploy preview renders cleanly. Two optional suggestions inline, fine to leave as is.

Nice addition, LGTM!

Thanks @chalin! I appreciate the review, and I've applied your suggestions.

I'm going to bypass the merge reqs (2 approvals) to merge this in as is now.

@nate-double-u
nate-double-u merged commit 67dbd1e into mainAug 6, 2026
5 checks passed
@nate-double-u
nate-double-u deleted the copilot/update-site-search-page branch August 6, 2026 19:17
Sign up for freeto 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.

Update site search page

4 participants

@nate-double-u@chalin