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

docs: update Comparison #252

Merged
merged 2 commits into from
Mar 16, 2025
Merged

docs: update Comparison #252

merged 2 commits into from
Mar 16, 2025

Conversation

unnoq
Copy link
Owner

@unnoq unnoq commented Mar 16, 2025

Summary by CodeRabbit

  • Documentation
    • Enhanced the comparison table with detailed entries for four additional features: Lazy Router, Native Types, Standard Schema, and Batch Request.
    • Updated status indicators to provide a clear overview of feature support across different technologies.
    • Adjusted the table header layout for improved clarity and readability.

unnoq added 2 commits March 16, 2025 08:02
Copy link

vercel bot commented Mar 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 16, 2025 1:06am

Copy link

coderabbitai bot commented Mar 16, 2025

Walkthrough

The documentation file (apps/.../comparison.md) has been updated to enhance a comparison table for three technologies: oRPC, tRPC, and ts-rest. New feature rows have been added for Lazy Router, Native Types (Date, URL, Set, Maps, ...), Standard Schema, and Batch Request, each with status indicators. Additionally, the table header has been reformatted for improved clarity. Existing content remains unchanged.

Changes

File Change Summary
apps/.../comparison.md - Added new feature rows: "Lazy Router", "Native Types (Date, URL, Set, Maps, ...)", "Standard Schema", and "Batch Request" with status indicators for oRPC, tRPC, and ts-rest.
- Reformatted the table header for better alignment and clarity.

Poem

I'm a happy rabbit with ears so wide,
Hopping through code changes with joyful stride.
New features bloom like carrots in spring,
Lazy Routers and Native Types make my heart sing.
Oh, a schema so standard and a batch that's neat—coding delights make this update sweet!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 44466b7 and 70b1552.

📒 Files selected for processing (1)
  • apps/content/docs/comparison.md (1 hunks)
🔇 Additional comments (4)
apps/content/docs/comparison.md (4)

14-15: Enhanced Table Header for Improved Readability

The reformatting of the table header now clearly separates the column titles from the content. The consistent alignment and clear demarcation using the markdown syntax enhances the overall readability of the table.


29-30: Addition of New Feature Rows: "Lazy Router" & "Native Types"

The rows for "Lazy Router" and "Native Types (Date, URL, Set, Maps, ...)" have been added with appropriate status indicators (✅, 🟡, 🛑) that are consistent with the legend defined earlier in the file. This update provides enhanced insights into feature support across oRPC, tRPC, and ts-rest.


31-32: Inclusion of "Standard Schema" Feature

The new row for "Standard Schema" is well integrated into the table. The status indicators (✅ for oRPC and tRPC, 🛑 for ts-rest) are clearly presented, maintaining consistency with other rows. This addition enriches the comparison by highlighting schema support capabilities.


36-36: Addition of "Batch Request" Feature

The "Batch Request" row is added with clear and consistent status indicators across the three technologies (🛑 for oRPC and ts-rest, ✅ for tRPC). This update effectively rounds out the comparison by addressing batch processing support.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, 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 generate docstrings to generate docstrings for this 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Mar 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link

pkg-pr-new bot commented Mar 16, 2025

Open in Stackblitz

More templates

@orpc/client

npm i https://pkg.pr.new/@orpc/client@252

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@252

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@252

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@252

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@252

@orpc/server

npm i https://pkg.pr.new/@orpc/server@252

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@252

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@252

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@252

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@252

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@252

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@252

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@252

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@252

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@252

commit: 70b1552

@unnoq unnoq merged commit 33ca37d into main Mar 16, 2025
8 checks passed
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.

None yet

1 participant