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

docs(search): add basic index search #290

Merged

Conversation

danielleroux
Copy link
Collaborator

@danielleroux danielleroux commented Jan 12, 2023

Pull request checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)
  • Build (yarn build) was run locally and any changes were pushed
  • Unit tests (yarn test) were run locally and passed
  • Visual Regression Tests (yarn visual-regression) were run locally and passed
  • Linting (npm lint) was run locally and passed

Pull request type

Please check the type of change your PR introduces:

  • Bug fix
  • Feature
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the new behavior?

Does this introduce a breaking change?

  • Yes
  • No

@danielleroux danielleroux added the Documentation Improvements or additions to documentation label Jan 12, 2023
@danielleroux danielleroux added this to the 1.3.0 milestone Jan 12, 2023
@danielleroux danielleroux linked an issue Jan 12, 2023 that may be closed by this pull request
2 tasks
Copy link
Collaborator

@nuke-ellington nuke-ellington left a comment

Choose a reason for hiding this comment

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

Cannot review the search functionality since the input field says Loading.. and will not change.

@danielleroux
Copy link
Collaborator Author

danielleroux commented Jan 13, 2023

@nuke-ellington

Cannot review the search functionality since the input field says Loading.. and will not change.

You have to build docusaurus, because index is only generated during build time. (https://github.com/praveenn77/docusaurus-lunr-search#how-to-use- see Note)

yarn build
yarn workspace documentation serve

@nuke-ellington
Copy link
Collaborator

@danielleroux Search looks nice :) But somehow theme is not loading in playground it seems:

Screenshot 2023-01-13 at 11 09 52

@danielleroux
Copy link
Collaborator Author

@danielleroux Search looks nice :) But somehow theme is not loading in playground it seems:

Screenshot 2023-01-13 at 11 09 52

@nuke-ellington Cannot reproduce this behavior 👀

@danielleroux
Copy link
Collaborator Author

@nuke-ellington can you try to host the build folder with npx http-server ./build?

Copy link
Collaborator

@nuke-ellington nuke-ellington left a comment

Choose a reason for hiding this comment

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

lgtm

@danielleroux danielleroux merged commit 2168cf9 into main Jan 13, 2023
@danielleroux danielleroux deleted the 63-adding-multiple-tags-and-search-to-documentation branch January 13, 2023 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants