search

synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

feat(docs): Adds search #3229

Closed abtestingalpha closed 2 months ago

abtestingalpha commented 2 months ago

Description Adds search to docs.

Summary by CodeRabbit

5892df3025c3013fd8aab5bab935cdb09258f190: docs preview link

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the addition of a local search plugin to the Docusaurus configuration for the documentation site. Specifically, the searchPlugin from the @easyops-cn/docusaurus-search-local package has been imported and configured with specific options. Additionally, the package.json file has been updated to include this new dependency, ensuring that the necessary package is available for the documentation site to utilize the local search functionality.

Changes

File Change Summary
docs/bridge/docusaurus.config.ts Added searchPlugin import and configuration with options { hashed: true, language: ['en'] }.
docs/bridge/package.json Added dependency "@easyops-cn/docusaurus-search-local": "^0.44.5" to dependencies.

Poem

In the garden of code, a new search does bloom,
With options so bright, it dispels all the gloom.
A hop here, a skip there, now find what you seek,
In the world of our docs, it's the search we now speak! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 2 months ago

Bundle Report

Changes will increase total bundle size by 5.95MB (16.69%) :arrow_up::warning:, exceeding the configured threshold of 5%.

Bundle name Size Change
sdk-router-@synapsecns/sdk-router-esm* 255.08kB 426 bytes (0.17%) :arrow_up:
sdk-router-@synapsecns/sdk-router-cjs* 117.47kB 234 bytes (0.2%) :arrow_up:
explorer-ui-server-cjs* 866.14kB 76 bytes (0.01%) :arrow_up:
explorer-ui-client-array-push* 2.31MB 152 bytes (0.01%) :arrow_up:
synapse-interface-client-array-push* 7.28MB 746 bytes (0.01%) :arrow_up:
synapse-interface-server-cjs* 1.64MB 147.92kB (9.9%) :arrow_up::warning:
widget-cjs-esm* 271.27kB 2.03kB (-0.74%) :arrow_down:
docs-bridge-client-array-push 10.27MB 2.37MB (29.94%) :arrow_up::warning:
docs-bridge-server-cjs 17.96MB 3.09MB (20.74%) :arrow_up::warning:
synapse-constants-esm-cjs* 174.63kB 174.63kB (100%) :arrow_up::warning:
synapse-constants-cjs-esm* 174.18kB 174.18kB (100%) :arrow_up::warning:

ℹ️ *Bundle size includes cached data from a previous commit

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: a10d955
Status: ✅  Deploy successful!
Preview URL: https://f1b07f01.sanguine-fe.pages.dev
Branch Preview URL: https://docs-search.sanguine-fe.pages.dev

View logs