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

migrate docusaurus to v3 and add search for documentation #12681

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

aalves08
Copy link
Member

@aalves08 aalves08 commented Nov 26, 2024

Summary

Fixes #12653

Occurred changes and/or fixed issues

  • migrate docusaurus to v3
  • add search for documentation (search index will only happen in build... won't work in dev mode)

Technical notes summary

https://docusaurus.io/docs/migration/v3 + https://docusaurus.io/community/resources#search + https://github.com/lelouch77/docusaurus-lunr-search + https://www.npmjs.com/package/docusaurus-lunr-search

Areas or cases that should be tested

  • test all of the relevant commands, yarn docs:install, yarn docs:start, yarn docs:start and yarn docs:serve (this serves the built assets and the search can be tested)

Areas which could experience regressions

Screenshot/Video

Screenshot 2024-11-26 at 17 45 28

Checklist

  • The PR is linked to an issue and the linked issue has a Milestone, or no issue is needed
  • The PR has a Milestone
  • The PR template has been filled out
  • The PR has been self reviewed
  • The PR has a reviewer assigned
  • The PR has automated tests or clear instructions for manual tests and the linked issue has appropriate QA labels, or tests are not needed
  • The PR has reviewed with UX and tested in light and dark mode, or there are no UX changes

@aalves08 aalves08 added this to the v2.11.0 milestone Nov 26, 2024
@aalves08 aalves08 self-assigned this Nov 26, 2024
@aalves08
Copy link
Member Author

FYI @nwmac @richard-cox

Sign up for free to 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.

Add site search to Extensions dev kit page
1 participant