PoC: Replace theme search with Algolia DocSearch#755
Draft
waxzce wants to merge 2279 commits into
Draft
Conversation
## Describe your PR Vale is not working anymore in CI. This PR fixes the default archetype to avoid the error Co-authored-by: Clément Nivolle <cnivolle@gmail.com>
## Describe your PR This PR adds AI instructions to the Clever Cloud documentation: - The filename is `.cursorrules` as it's detected by many AI tools, but it can evolve over time - It's a combination of contribution guidelines, `README.md`, existing content analysis - It should help to create new pages 1st iteration, rewrite existing, reorganization - It can also be used locally to use AI to check if a content follows basic rules Such document should evolve over time to follow ecosystem tools, models, how we write and enhance documentation. The goal here is to init such process, experiment and iterate. Co-authored-by: Clément Nivolle <cnivolle@gmail.com>
Hide theme search wrapper; render DocSearch button styled like the theme. – Inject #docsearch next to the original wrapper – Style DocSearch button for similar look & feel – Keyboard shortcuts (/ and Cmd/Ctrl+K), deferred init, prefill – Keep DocSearch params in config; enable theme search for header slot This is a proof of concept; visual polish and template-friendly integration still needed.
… component scaffolding)
✅ Review app deployedCheck how your changes look like!
|
Collaborator
|
I pushed some commits to:
CSS need more work but it could be a solution to get better results |
Member
Author
|
So, chat do we do about this ? We have a meeting or something ? |
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
9 participants
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.
This PR replaces the theme’s built-in search UI with Algolia DocSearch as a proof of concept. The existing theme search wrapper is hidden, and a DocSearch trigger is rendered in the header and styled to resemble the previous input. Functionally, it opens the DocSearch modal and supports common shortcuts (/ and Cmd/Ctrl+K). Initialization is made resilient with deferred loading and prefill logic.
Why
I was frustrated by the limited quality of the current client-side search in our documentation. This PoC demonstrates a working DocSearch integration that can be refined visually and made cleaner in terms of templating.
Scope and Notes
Caveats / Known Issues
Questions
Next Steps (if accepted)