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

Add search capabilities to documentation #522

Merged
merged 5 commits into from
Dec 26, 2024

Conversation

ben-fornefeld
Copy link
Contributor

this pr adds the following:

  1. non "api-reference" or "sdk-reference" documentation files are indexed on build time and made full text searchable via flexsearch
  2. <Search /> component is added to the docs navigation on desktop & mobile accordingly
  3. preview snippets are visualised for each SearchResult

@ben-fornefeld ben-fornefeld added the docs Improvements or additions to documentation label Dec 26, 2024
@ben-fornefeld ben-fornefeld self-assigned this Dec 26, 2024
Copy link

linear bot commented Dec 26, 2024

Copy link

changeset-bot bot commented Dec 26, 2024

⚠️ No Changeset found

Latest commit: c565bdb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Member

@mishushakov mishushakov left a comment

Choose a reason for hiding this comment

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

Works for me

@mishushakov
Copy link
Member

Can't find anything in the SDK reference though, is this expected?
Do you have example searching the SDK reference?

@ben-fornefeld ben-fornefeld merged commit b9cb0ae into main Dec 26, 2024
2 checks passed
@ben-fornefeld ben-fornefeld deleted the make-docs-searchable-e2b-1364 branch December 26, 2024 19:37
@ben-fornefeld
Copy link
Contributor Author

Can't find anything in the SDK reference though, is this expected? Do you have example searching the SDK reference?

this was discussed internally and is expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants