Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughReorganized the VitePress docs site navigation and sidebars: removed top-level Examples, promoted Blog, added /docs/{comparison,ecosystem,playgrounds}, nested Examples under Integrations with /docs/examples/openai-streaming, removed the old Others and standalone /examples/ sidebar; plus small punctuation/formatting edits and an Ecosystem entry update. Changes
Sequence Diagram(s)(omitted — changes are configuration and documentation edits without runtime control-flow modifications) Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. ✨ Finishing Touches
🧪 Generate unit tests
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. Comment |
dosubot
Bot
added
the
size:M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @unnoq, I'm Gemini Code Assist1! 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 focuses on enhancing the user experience of the documentation by restructuring the navigation and sidebar. The changes aim to make content more intuitive to find by consolidating related sections and improving the overall flow of information, alongside minor textual refinements for clarity.
Highlights
- Documentation Navigation Reorganization: The primary navigation bar has been streamlined by removing the direct 'Examples' link, and the sidebar structure has been significantly reorganized to improve content discoverability.
- Examples Content Integration: All example documentation, specifically 'OpenAI Streaming', has been moved from a separate top-level section into a new, collapsible 'Examples' group within the main '/docs/' sidebar, and the corresponding file was relocated.
- Sidebar Content Consolidation: Previously grouped items like 'Comparison', 'Ecosystem', and 'Playgrounds' have been elevated from a generic 'Others' section to direct entries within the main '/docs/' sidebar, enhancing their visibility.
- Minor Textual and Punctuation Improvements: Several documentation files received minor edits to improve readability and correct punctuation, specifically changing em-dashes to commas for better flow.
- Ecosystem Page Update: The 'Ecosystem' documentation page was updated to reflect a name change and new description for the Drizzle ORM generator entry.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request effectively reorganizes the documentation's navigation and sidebar to improve discoverability. Key changes include moving the 'Examples' section into the 'Docs' sidebar and promoting several pages to top-level items. The implementation is consistent, with corresponding updates to configuration, file paths, and minor content enhancements. The changes are well-executed and improve the overall structure and readability of the documentation. I have no concerns with the proposed changes.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/experimental-durable-event-iterator
@orpc/hey-api
@orpc/interop
@orpc/json-schema
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/otel
@orpc/react
@orpc/react-query
@orpc/experimental-react-swr
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
apps/content/docs/examples/openai-streaming.md (1)
36-37: Add a matching "SERVER" delimiter for symmetry.You added a clear CLIENT divider. Consider adding a matching SERVER divider above the server snippet to help readers scan the code.
Example:
// --------------- SERVER --------------- const complete = os .input(z.object({ content: z.string() })) .handler(async function* ({ input }) { /* ... */ })apps/content/docs/integrations/tanstack-query-old/basic.md (1)
85-87: Polish: container syntax + wording.
- Prefer the VitePress container form with a space:
::: info.- Slight grammar tweak.
-:::info -The `.key` accepts partial deep input, there's no need to supply full input. +::: info +The `.key` accepts a deep partial of the input; there's no need to supply the full input.apps/content/docs/event-iterator.md (1)
8-8: LGTM — clearer lead sentence.Reads better and sets context quickly. While here, consider fixing the front‑matter description (“Learn how to streaming…”) to “Learn how to stream…”.
apps/content/docs/client/server-side.md (1)
8-8: Rephrase for clarity.A small grammar tweak improves flow.
-Call your [procedures](/docs/procedure) in the same environment as your server, no proxies required like native functions. +Call your [procedures](/docs/procedure) in the same environment as your server—like native functions, with no proxies required.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
apps/content/.vitepress/config.ts(3 hunks)apps/content/docs/client/server-side.md(1 hunks)apps/content/docs/context.md(1 hunks)apps/content/docs/ecosystem.md(1 hunks)apps/content/docs/event-iterator.md(1 hunks)apps/content/docs/examples/openai-streaming.md(2 hunks)apps/content/docs/getting-started.md(1 hunks)apps/content/docs/integrations/tanstack-query-old/basic.md(1 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: lint
- GitHub Check: test
- GitHub Check: publish-commit
🔇 Additional comments (5)
apps/content/docs/examples/openai-streaming.md (1)
51-53: LGTM — useful cross-links.The info box and links read well and are accurate.
apps/content/docs/getting-started.md (1)
10-10: LGTM — punctuation consistency.Change improves readability and matches the style across docs.
apps/content/docs/context.md (1)
62-62: LGTM — punctuation fix.Comma reads better than an em dash here.
apps/content/docs/ecosystem.md (1)
29-29: LGTM — DRZL entry update looks good.Name, link, and description align with the new branding.
apps/content/.vitepress/config.ts (1)
86-99: Nav/sidebar restructure verified—no stale links or missing pages detected.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
apps/content/.vitepress/config.ts (1)
72-72: Prefer linking Blog nav to the blog index for future-proofing.Point the top-level Blog link to
/blog/instead of a specific post to avoid churn as new posts are added.- { text: 'Blog', link: '/blog/v1-announcement', activeMatch: '/blog/' }, + { text: 'Blog', link: '/blog/', activeMatch: '/blog/' },
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
apps/content/.vitepress/config.ts(4 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: lint
- GitHub Check: publish-commit
- GitHub Check: test
🔇 Additional comments (3)
apps/content/.vitepress/config.ts (3)
86-86: OK — "Comparison" page exists.
apps/content/docs/comparison.md is present; no action required.
98-99: No action required — pages exist and no stale 'others' links remain.apps/content/docs/ecosystem.md and apps/content/docs/playgrounds.md are present; inbound links updated in apps/content/index.md, apps/content/docs/integrations/opentelemetry.md, and apps/content/docs/advanced/publish-client-to-npm.md.
203-209: Add redirect and sweep old /examples/ links — new page exists, repo search inconclusive
- apps/content/docs/examples/openai-streaming.md is present; apps/content/.vitepress/config.ts has no '/examples/' sidebar entry.
- Add a redirect from /examples/openai-streaming → /docs/examples/openai-streaming (server rule on Netlify/Vercel or a small stub page at /examples/openai-streaming).
- Sweep repo for remaining references; automated check here was inconclusive (ripgrep skipped files). Run locally: rg -n --hidden -uu '/examples/openai-streaming|examples/openai-streaming|/examples/' -g '!/node_modules/' and update any matches.
1 participant
Summary by CodeRabbit