search

synapsecns / sanguine

Synapse Monorepo
MIT License
43 stars 31 forks source link

Docs/blog api img #3249

Closed lawsonkight closed 1 month ago

lawsonkight commented 1 month ago

Initial .png for REST API blog post.

Future improvements:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

This pull request introduces several new documentation files related to the Synapse REST API and blog enhancements. A new blog post details the API's launch, functionality, and key endpoints. Additionally, an entry for "Synapse Protocol Developers" is added to the authors' list. A welcome markdown file for the Synapse Technical Blog is created, outlining its purpose and content. Updates to the Docusaurus configuration enhance the blog's structure, while modifications to the homepage redirect users to a specific About page.

Changes

File Path Change Summary
docs/bridge/blog-posts/2024-10-10-rest-api-post.md New file introducing the Synapse REST API, its functionality, and key endpoints.
docs/bridge/blog-posts/authors.yml New entry for "Synapse Protocol Developers" added to the authors list.
docs/bridge/blog-posts/welcome.md New introductory post for the Synapse Technical Blog, outlining content and audience.
docs/bridge/docs/02-Bridge/05-Supported-Routes.md Sidebar label corrected from "Supported Rotues" to "Supported Routes."
docs/bridge/docs/02-Bridge/_05-Supported-Routes.md New file created with sidebar label "Supported Routes" detailing supported tokens.
docs/bridge/src/components/APIFlow.tsx New file introducing a React component that renders an SVG API flow diagram.
docs/bridge/src/css/custom.css New CSS variables added for enhanced color customization; width property of figure removed.
docs/bridge/docusaurus.config.ts Enhancements to Docusaurus configuration for blog features, including new paths and settings.

Possibly related PRs

Suggested labels

size/xs, M-deps

Suggested reviewers

Poem

🐰 In the meadow where knowledge grows,
A new API blooms, as everyone knows.
With paths to explore and endpoints to find,
The Synapse Bridge welcomes all kinds.
Join us in learning, let your code take flight,
In the world of Synapse, everything feels right! 🌟

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.
cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying sanguine-fe with  Cloudflare Pages  Cloudflare Pages

Latest commit: c837def
Status: âœ…  Deploy successful!
Preview URL: https://1a442ef4.sanguine-fe.pages.dev
Branch Preview URL: https://docs-blog-api-img.sanguine-fe.pages.dev

View logs

codecov[bot] commented 1 month ago

Bundle Report

Changes will decrease total bundle size by 3.5MB (-9.82%) :arrow_down:. This is within the configured threshold :white_check_mark:

Detailed changes | Bundle name | Size | Change | | ----------- | ---- | ------ | | sdk-router-@synapsecns/sdk-router-esm* | 255.08kB | 426 bytes (0.17%) :arrow_up: | | sdk-router-@synapsecns/sdk-router-cjs* | 527.17kB | 409.93kB (349.65%) :arrow_up: | | explorer-ui-server-cjs* | 708.77kB | 157.29kB (-18.16%) :arrow_down: | | explorer-ui-client-array-push* | 2.15MB | 162.81kB (-7.04%) :arrow_down: | | synapse-interface-client-array-push* | 7.38MB | 100.07kB (1.38%) :arrow_up: | | synapse-interface-server-cjs* | 1.65MB | 150.9kB (10.1%) :arrow_up: | | widget-cjs-esm* | 271.27kB | 2.03kB (-0.74%) :arrow_down: | | docs-bridge-client-array-push | 7.28MB | 619.5kB (-7.84%) :arrow_down: | | docs-bridge-server-cjs | 11.31MB | 3.57MB (-23.99%) :arrow_down: | | synapse-constants-esm-cjs* | 174.63kB | 174.63kB (100%) :arrow_up: | | synapse-constants-cjs-esm* | 174.18kB | 174.18kB (100%) :arrow_up: |

ℹī¸ *Bundle size includes cached data from a previous commit