Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 11 additions & 14 deletions apps/content/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,11 @@ export default withMermaid(defineConfig({
nav: [
{ text: 'Docs', link: '/docs/getting-started', activeMatch: '/docs/(?!openapi/)' },
{ text: 'OpenAPI', link: '/docs/openapi/getting-started', activeMatch: '/docs/openapi/' },
{ text: 'Examples', link: '/examples/openai-streaming', activeMatch: '/examples/' },
{ text: 'Blog', link: '/blog/v1-announcement', activeMatch: '/blog/' },
{ text: 'Learn & Contribute', link: '/learn-and-contribute/overview', activeMatch: '/learn-and-contribute/' },
{
text: 'About',
items: [
{ text: 'Blog', link: '/blog/v1-announcement' },
{ text: 'Discussions', link: 'https://github.com/unnoq/orpc/discussions' },
{ text: 'Sponsor', link: 'https://github.com/sponsors/unnoq' },
{ text: 'Releases', link: 'https://github.com/unnoq/orpc/releases' },
Expand All @@ -84,6 +83,7 @@ export default withMermaid(defineConfig({
sidebar: {
'/docs/': [
{ text: 'Getting Started', link: '/docs/getting-started' },
{ text: 'Comparison', link: '/docs/comparison' },
{ text: 'Procedure', link: '/docs/procedure' },
{ text: 'Router', link: '/docs/router' },
{ text: 'Middleware', link: '/docs/middleware' },
Expand All @@ -95,6 +95,8 @@ export default withMermaid(defineConfig({
{ text: 'Metadata', link: '/docs/metadata' },
{ text: 'RPC Handler', link: '/docs/rpc-handler' },
{ text: 'OpenAPI', link: '/docs/openapi/getting-started' },
{ text: 'Ecosystem', link: '/docs/ecosystem' },
{ text: 'Playgrounds', link: '/docs/playgrounds' },
{
text: 'Contract First',
collapsed: true,
Expand Down Expand Up @@ -198,6 +200,13 @@ export default withMermaid(defineConfig({
{ text: 'tRPC', link: '/docs/openapi/integrations/trpc' },
],
},
{
text: 'Examples',
collapsed: true,
items: [
{ text: 'OpenAI Streaming', link: '/docs/examples/openai-streaming' },
],
},
{
text: 'Best Practices',
collapsed: true,
Expand Down Expand Up @@ -230,15 +239,6 @@ export default withMermaid(defineConfig({
{ text: 'Migrating from tRPC', link: '/docs/migrations/from-trpc' },
],
},
{
text: 'Others',
collapsed: true,
items: [
{ text: 'Playgrounds', link: '/docs/playgrounds' },
{ text: 'Comparison', link: '/docs/comparison' },
{ text: 'Ecosystem', link: '/docs/ecosystem' },
],
},
],
'/docs/openapi/': [
{ text: 'Getting Started', link: '/docs/openapi/getting-started' },
Expand Down Expand Up @@ -284,9 +284,6 @@ export default withMermaid(defineConfig({
],
},
],
'/examples/': [
{ text: 'OpenAI Streaming', link: '/examples/openai-streaming' },
],
'/blog/': [
{ text: 'V1 Announcement', link: '/blog/v1-announcement' },
],
Expand Down
2 changes: 1 addition & 1 deletion apps/content/docs/client/server-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Call your oRPC procedures in the same environment as your server li

# Server-Side Clients

Call your [procedures](/docs/procedure) in the same environment as your serverno proxies required like native functions.
Call your [procedures](/docs/procedure) in the same environment as your server, no proxies required like native functions.

## Calling Procedures

Expand Down
2 changes: 1 addition & 1 deletion apps/content/docs/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export default function fetch(request: Request) {

## Execution context

Execution context is computed during the process lifecycleusually via [middleware](/docs/middleware). It can be used independently or combined with initial context.
Execution context is computed during the process lifecycle, usually via [middleware](/docs/middleware). It can be used independently or combined with initial context.

```ts twoslash
import { os } from '@orpc/server'
Expand Down
2 changes: 1 addition & 1 deletion apps/content/docs/ecosystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If your project is missing here, please [open a PR](https://github.com/unnoq/orp
| [orpc-file-based-router](https://github.com/zeeeeby/orpc-file-based-router) | [![Stars](https://img.shields.io/github/stars/zeeeeby/orpc-file-based-router?style=flat)](https://github.com/zeeeeby/orpc-file-based-router) | Automatically creates an oRPC router configuration based on your file structure, similar to Next.js, express-file-routing |
| [Vertrag](https://github.com/Quatton/vertrag) | [![Stars](https://img.shields.io/github/stars/Quatton/vertrag?style=flat)](https://github.com/Quatton/vertrag) | A spec-first API development tool (oRPC contract + any backend language) |
| [Prisma oRPC Generator](https://github.com/omar-dulaimi/prisma-orpc-generator) | [![Stars](https://img.shields.io/github/stars/omar-dulaimi/prisma-orpc-generator?style=flat)](https://github.com/omar-dulaimi/prisma-orpc-generator) | Prisma generator that creates fully-featured ORPC routers |
| [Drizzle oRPC Generator](https://github.com/use-drzl/drzl) | [![Stars](https://img.shields.io/github/stars/use-drzl/drzl?style=flat)](https://github.com/use-drzl/drzl) | Drizzle generator that creates fully-featured ORPC routers |
| [DRZL](https://github.com/use-drzl/drzl) | [![Stars](https://img.shields.io/github/stars/use-drzl/drzl?style=flat)](https://github.com/use-drzl/drzl) | Zero‑friction codegen for Drizzle ORM. Analyze your schema. Generate validation, services, and routers — fast. |

## Libraries

Expand Down
2 changes: 1 addition & 1 deletion apps/content/docs/event-iterator.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to streaming responses, real-time updates, and server-sen

# Event Iterator (SSE)

oRPC provides built‑in support for streaming responses, real‑time updates, and server-sent events (SSE) without any extra configuration. This functionality is ideal for applications that require live updatessuch as AI chat responses, live sports scores, or stock market data.
oRPC provides built‑in support for streaming responses, real‑time updates, and server-sent events (SSE) without any extra configuration. This functionality is ideal for applications that require live updates, such as AI chat responses, live sports scores, or stock market data.

## Overview

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ const complete = os

const router = { complete }

// --------------- CLIENT ---------------

const link = new RPCLink({
url: 'https://example.com/rpc',
})
Expand All @@ -46,4 +48,6 @@ for await (const chunk of stream) {
}
```

::: info
Learn more about [RPCLink](/docs/client/rpc-link) and [Event Iterator](/docs/client/event-iterator).
:::
2 changes: 1 addition & 1 deletion apps/content/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Quick guide to oRPC

oRPC (OpenAPI Remote Procedure Call) combines RPC (Remote Procedure Call) with OpenAPI, allowing you to define and call remote (or local) procedures through a type-safe API while adhering to the OpenAPI specification.

oRPC simplifies RPC service definition, making it easy to build scalable applicationsfrom simple scripts to complex microservices.
oRPC simplifies RPC service definition, making it easy to build scalable applications, from simple scripts to complex microservices.

This guide covers the basics: defining procedures, handling errors, and integrating with popular frameworks.

Expand Down
2 changes: 1 addition & 1 deletion apps/content/docs/integrations/tanstack-query-old/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ mutation.mutate({ name: 'Earth' })
Use `.key` to generate a `QueryKey` or `MutationKey`. This is useful for tasks such as revalidating queries, checking mutation status, etc.

:::info
The `.key` accepts partial deep inputtheres no need to supply full input.
The `.key` accepts partial deep input, there's no need to supply full input.
:::

```ts
Expand Down
Loading