docs: Multiservice Monorepo Playground

[dinwwwh]

Fixes #1018

Summary by CodeRabbit

• Documentation
  • Updated monorepo setup best practices guide with improved organization and clarity.
  • Added new Multiservice Monorepo Playground with local development setup instructions and examples.
  • Enhanced documentation sections with clearer recommendations, tip blocks, and illustrative code examples demonstrating hybrid architectures.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
orpc	Building	Preview	Comment	Nov 12, 2025 7:53am

[coderabbitai]

Walkthrough

This PR updates oRPC documentation by restructuring the monorepo setup guide with reorganized sections, new code examples, and a tip block for constraints. Additionally, a new "Multiservice Monorepo Playground" entry is added to the playgrounds reference with its corresponding degit command.

Changes

Cohort / File(s)	Summary
Monorepo Setup Documentation apps/content/docs/best-practices/monorepo-setup.md	Restructured guide with new Playground info block, replaced details section with tip block, reintroduced Recommended Structure section with updated guidance on separating server and contract components, relabeled code-group examples from "[contract-first]" to "[Contract First]", added new hybrid architecture code example, and expanded surrounding context blocks.
Playground Registry apps/content/docs/playgrounds.md	Added "Multiservice Monorepo Playground" entry to Available Playgrounds table with GitHub source link and corresponding npx degit command for local development setup.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Documentation restructuring and content organization are straightforward to verify
• New playground entry addition follows existing patterns
• No logic changes or code execution paths to validate

Possibly related PRs

• docs: Add vue3 + bun community playground #1130: Both PRs add new playground entries to apps/content/docs/playgrounds.md with corresponding degit/local development commands, indicating parallel playground documentation work.

Poem

🐰 A monorepo playground takes the stage,
With hybrid structures on the page,
Best practices now crystal clear,
Server and contracts dancing here,
Tips and tricks to guide the way,
Documentation blooms today! 🌱

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title accurately captures the main change: adding documentation and playground entry for the Multiservice Monorepo Playground.
Linked Issues check	✅ Passed	The PR addresses the linked issue #1018 by updating documentation to reflect monorepo best practices and adding the corresponding playground entry.
Out of Scope Changes check	✅ Passed	All changes (documentation updates and playground entry addition) are directly related to the objectives outlined in issue #1018 for the monorepo playground.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch unnoq/issue1018

---

📜 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 48d6b8b and 1c49006.

📒 Files selected for processing (2)

• apps/content/docs/best-practices/monorepo-setup.md (5 hunks)
• apps/content/docs/playgrounds.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: publish-commit
• GitHub Check: lint
• GitHub Check: test

🔇 Additional comments (4)

apps/content/docs/best-practices/monorepo-setup.md (3)

68-68: Confirm code-group label formatting.

The labels have been updated to Title Case format ([Contract First], [Service First], [Hybrid]). Verify that your documentation framework correctly renders these labels in the code-group block. Additionally, ensure the new [Hybrid] example is clearly differentiated from the other two patterns and accurately represents a valid production-ready structure.

Also applies to: 78-78, 88-97

---

44-53: Admonition blocks are well-structured.

The conversion to a :::tip block for the composite constraint warning (lines 44-53) improves readability and visual emphasis. The addition of the :::info block (lines 101-103) provides an appropriate disclaimer about architectural flexibility.

Also applies to: 101-103

---

12-14: Playground link verified—no action required.

The Multiservice Monorepo Playground link is correct and consistent across both documentation files. The repository unnoq/orpc-multiservice-monorepo-playground exists, is active, and the URLs in monorepo-setup.md (lines 12-14) and playgrounds.md (line 27) match exactly.

apps/content/docs/playgrounds.md (1)

27-27: External repository is valid and accessible.

The multiservice monorepo playground repository (unnoq/orpc-multiservice-monorepo-playground) exists and is publicly accessible with an active maintenance status (not archived). The documentation entry and degit command reference are valid.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @unnoq, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation by introducing a new 'Multiservice Monorepo Playground' to offer a concrete example of monorepo configurations. It also refines the existing monorepo setup guide, improving its structure, clarifying terminology, and adding a new 'Hybrid' architectural pattern, thereby providing clearer guidance for users.

Highlights

• New Playground Introduction: A new 'Multiservice Monorepo Playground' has been introduced, providing a practical example for monorepo setups and linked within the documentation.
• Documentation Enhancement: The monorepo-setup.md documentation has been updated to include a new 'Hybrid' recommended structure for monorepos, offering more architectural guidance.
• Terminology Refinement: Terminology in monorepo-setup.md has been refined by renaming 'contract-first' to 'Contract First' and 'normal' to 'Service First' in code examples for clarity.
• Documentation Structure Improvement: The flow of the monorepo-setup.md document has been improved by reordering the 'Recommended Structure' section and changing a details admonition to a tip for better readability.
• Playground Discoverability: The new Multiservice Monorepo Playground has been integrated into the playgrounds.md list, making it easily discoverable and providing its degit command for quick setup.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request effectively adds documentation for the new Multiservice Monorepo Playground. The changes are well-structured, adding a link to the playground, updating the monorepo setup guide with a new 'Hybrid' example, and including it in the list of available playgrounds. The refactoring of the monorepo-setup.md file also improves its readability. I have one minor suggestion to further enhance the clarity of the new code example.

[pkg-pr-new]

More templates

• @orpc/astro-playground
• @orpc/browser-extension-playground
• @orpc/bun-websocket-otel-playground
• @orpc/cloudflare-worker-playground
• @orpc/contract-first-playground
• @orpc/electron-playground
• @orpc/nest-playground
• @orpc/next-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground
• @orpc/tanstack-start-playground

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@1209

@orpc/arktype

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

@orpc/client

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

@orpc/contract

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

@orpc/experimental-durable-iterator

npm i https://pkg.pr.new/@orpc/experimental-durable-iterator@1209

@orpc/hey-api

npm i https://pkg.pr.new/@orpc/hey-api@1209

@orpc/interop

npm i https://pkg.pr.new/@orpc/interop@1209

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@1209

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@1209

@orpc/openapi

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

@orpc/openapi-client

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

@orpc/otel

npm i https://pkg.pr.new/@orpc/otel@1209

@orpc/experimental-pino

npm i https://pkg.pr.new/@orpc/experimental-pino@1209

@orpc/experimental-publisher

npm i https://pkg.pr.new/@orpc/experimental-publisher@1209

@orpc/experimental-ratelimit

npm i https://pkg.pr.new/@orpc/experimental-ratelimit@1209

@orpc/react

npm i https://pkg.pr.new/@orpc/react@1209

@orpc/react-query

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

@orpc/experimental-react-swr

npm i https://pkg.pr.new/@orpc/experimental-react-swr@1209

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-aws-lambda

npm i https://pkg.pr.new/@orpc/standard-server-aws-lambda@1209

@orpc/standard-server-fastify

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/standard-server-peer

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

@orpc/svelte-query

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

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@1209

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@1209

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: 1c49006

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!