docs(plugin-docsearch): add jsdoc and improve docs #533
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds detailed JSDoc documentation to various DocSearch plugin files and updates both the English and Chinese documentation with improved wording and corrections.
- Added JSDoc comments and examples in TypeScript source files
- Revised documentation texts for clarity and grammatical accuracy in both English and Chinese
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/search/plugin-docsearch/src/shared/options.ts | Added JSDoc comments for DocSearch locale and main options |
| plugins/search/plugin-docsearch/src/node/docsearchPlugin.ts | Added comprehensive JSDoc comments and example usage for the plugin |
| plugins/search/plugin-docsearch/src/client/helpers/docsearch.ts | Documented client options and helper functions for DocSearch config |
| docs/zh/plugins/search/docsearch.md | Revised Chinese documentation for clarity and consistency |
| docs/plugins/search/docsearch.md | Revised English documentation for clarity and accurate anchor links |
Pull Request Test Coverage Report for Build 15464278257Details
💛 - Coveralls |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.