Add search

[mrubens]

Important

Add local search functionality to documentation using @easyops-cn/docusaurus-search-local and update configuration.

• Search Functionality:
  • Adds @easyops-cn/docusaurus-search-local to package.json dependencies.
  • Configures search plugin in docusaurus.config.ts with options like hashed, language, and highlightSearchTermsOnTargetPage.
• Documentation:
  • Removes a section in docs/faq.md about configuring AI providers and models.

^{This description was created by for 65daf55. It will automatically update as commits are pushed.}

[ellipsis-dev]

❌ Changes requested. Reviewed everything up to cc5c468 in 1 minute and 25 seconds

More details

• Looked at 45 lines of code in 2 files
• Skipped 1 files when reviewing.
• Skipped posting 3 drafted comments based on config settings.

1. package.json:24

• Draft comment:
  React and react-dom version set to ^19.0.0 appears unconventional; ensure this is intentional and that all dependencies support React 19.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

2. docusaurus.config.ts:5

• Draft comment:
  Avoid using @ts-ignore for the DocSearchConfig import; instead, fix underlying type issues or add proper type declarations.
• Reason this comment was not posted:
  Marked as duplicate.

3. package.json:20

• Draft comment:
  Ensure the newly added @easyops-cn/docusaurus-search-local dependency is compatible with Docusaurus 3.7.0 and add tests to confirm search functionality.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 50% <= threshold 50%
  The comment is asking the PR author to ensure compatibility of a new dependency with a specific version of Docusaurus and to add tests for the search functionality. This is a specific request related to testing, which is allowed. However, the part about ensuring compatibility is not allowed as it asks the author to confirm something.

Workflow ID: wflow_hVC75Z59CT6HqnXL

---

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

👍 Looks good to me! Incremental review on 65daf55 in 1 minute and 11 seconds

More details

• Looked at 49 lines of code in 3 files
• Skipped 1 files when reviewing.
• Skipped posting 7 drafted comments based on config settings.

1. docs/faq.md:69

• Draft comment:
  Removal of the configuration link seems intentional. Confirm that users still have guidance on setting up API providers if needed.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

2. docusaurus.config.ts:50

• Draft comment:
  Good addition of the search plugin config. Verify that the docsRouteBasePath setting ('/') aligns with your docs routing setup to avoid potential conflicts.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

3. package.json:20

• Draft comment:
  Dependency added for search plugin looks correct. Confirm that '^0.48.5' is compatible with the Docusaurus version in use.
• Reason this comment was not posted:
  Confidence changes required: 50% <= threshold 50%
  None

4. package.json:24

• Draft comment:
  The React and React DOM versions are specified as '^19.0.0'. Ensure this version is stable and fully compatible with your tooling.
• Reason this comment was not posted:
  Comment was not on a location in the diff, so it can't be submitted as a review comment.

5. docs/faq.md:69

• Draft comment:
  Confirm that the removal of the link to 'Configuring Your AI Provider and Model' is intentional. This reference may help users set up their API provider.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 30% <= threshold 50%
  The comment is asking the PR author to confirm their intention regarding the removal of a link. This violates the rule against asking for confirmation of intention. However, it does point out a potential issue with user guidance, which could be useful if rephrased as a suggestion rather than a question.

6. docusaurus.config.ts:50

• Draft comment:
  New search plugin configuration added. Verify that 'docsRouteBasePath' set to '/' matches the intended routing structure for documentation.
• Reason this comment was not posted:
  Comment looked like it was already resolved.

7. package.json:18

• Draft comment:
  Dependency '@easyops-cn/docusaurus-search-local' has been added. Ensure that the chosen version (^0.48.5) aligns with other dependencies for stability.
• Reason this comment was not posted:
  Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
  This comment is about a dependency change, which is not allowed according to the rules. It suggests ensuring version alignment, which is a general caution and not a specific actionable suggestion.

Workflow ID: wflow_a1O5f5NxDoQfvn9i

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.