Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable pagefind for draft docs #9443

Open
wants to merge 1 commit into
base: 5.0.0-beta
Choose a base branch
from

Conversation

lorenzolewis
Copy link
Contributor

@lorenzolewis lorenzolewis commented Sep 18, 2024

Description (required)

POC to enable Pagefind for the beta site as the Algolia search is currently using the production site and doesn't match up with the content here.

Related issues & labels (optional)

  • Closes #
  • Suggested label:

Copy link

netlify bot commented Sep 18, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 4dc0c64
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/66eb29e19a3c1f000807c652
😎 Deploy Preview https://deploy-preview-9443--astro-docs-2.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 site configuration.

@lorenzolewis
Copy link
Contributor Author

lorenzolewis commented Sep 18, 2024

Two immediate issues discovered with this:

  • No (easy) way to edit the ranking page results. For example, the Content Collections guide is the 11th result. Put in a discussion on the Starlight repo for this: Ability to adjust pagefind search result weighting on a page level starlight#2348
  • No way to group individual results. Right now we have groups such as References, Learn, and Recipes to aid and give the user context when navigating results. This could potentially be solved with some hierarchy in the Pagefind search UI and also exposed in some way in Starlight, but I'm unfamiliar with this area.

Additionally we would need to review the accessibility and page navigation between the Algolia UI and Pagefind UI and make sure there isn't lost functionality.

@sarah11918
Copy link
Member

I will note that for the searches "content layer" and "loaders", this Page find version is far better. And, for these beta docs, maybe it's OK to optimize for that?

@lorenzolewis lorenzolewis changed the title Draft: Enable pagefind Enable pagefind for draft docs Sep 19, 2024
@lorenzolewis lorenzolewis marked this pull request as ready for review September 19, 2024 12:24
@lorenzolewis
Copy link
Contributor Author

Converting this to ready for review in case we would like to merge it. Note that this adds just over a minute to the build time when enabled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants