docs: update "Getting Started with OpenAPI"

[unnoq]

Summary by CodeRabbit

• Documentation

  • Enhanced the OpenAPI getting-started guide with comprehensive details on supported schemas.
  • Added a link for users to access the full list of available schemas.

• Style

  • Improved formatting of the schemaConverters array for better readability.

[vercel]

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 20, 2025 3:30am

[coderabbitai]

Walkthrough

This pull request updates the OpenAPI documentation by replacing a brief mention of support for Zod with a detailed block on a wide range of standard schemas. It also reformats the schemaConverters array from a single line to a multi-line format for improved readability. The changes are confined to the documentation file and do not affect the underlying code logic.

Changes

File	Change Summary
apps/content/docs/.../getting-started.md	Replaced the generic OpenAPI specs statement with a detailed block listing support for multiple standard schemas and a link to the full list. Re-formatted the schemaConverters array to span multiple lines.

Possibly related PRs

• docs: update Comparison #252: The changes in the main PR regarding OpenAPI specifications and the modifications in the retrieved PR that mention "Standard Schema" are related, as both involve updates to schema support in the context of oRPC.

Poem

I'm a rabbit hopping through updated docs,
New schemas and formatting, no more shocks.
Lines spread out like fields in bloom,
Guiding users through every room.
Crunching carrots and docs with glee,
This little change makes me hop with glee!
🥕🐰

---

📜 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 c8d3808 and eb5bdfe.

📒 Files selected for processing (1)

• apps/content/docs/openapi/getting-started.md (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• apps/content/docs/openapi/getting-started.md

---

🪧 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

Open in Stackblitz

More templates

• @orpc/contract-first-playground
• @orpc/nextjs-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@273

@orpc/client

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

@orpc/openapi

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

@orpc/contract

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

@orpc/openapi-client

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

@orpc/react-query

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

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@273

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: eb5bdfe

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

apps/content/docs/openapi/getting-started.md (1)

172-174: Enhanced Documentation Info Block Added
The new info block clearly communicates that a wide range of Standard Schema is supported for OpenAPI generation and provides a useful link to the full list of supported schemas. This is a welcome improvement over the previous single-line mention of Zod only.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a8e421c and c8d3808.

📒 Files selected for processing (1)

• apps/content/docs/openapi/getting-started.md (1 hunks)

🔇 Additional comments (1)

apps/content/docs/openapi/getting-started.md (1)

182-184: Improved Multi-line Formatting for schemaConverters Array
Reformatting the schemaConverters array into a multi-line structure greatly enhances readability and maintainability. It now aligns better with our documentation standards.