Skip to content

Conversation

@NathanFlurry
Copy link
Member

No description provided.

@vercel
Copy link

vercel bot commented Nov 22, 2025

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

Project Deployment Preview Comments Updated (UTC)
rivet-site Ready Ready Preview Comment Nov 22, 2025 1:17am
3 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
rivet-cloud Ignored Ignored Nov 22, 2025 1:17am
rivet-inspector Ignored Ignored Preview Nov 22, 2025 1:17am
rivetkit-serverless Skipped Skipped Nov 22, 2025 1:17am

@vercel vercel bot temporarily deployed to Preview – rivetkit-serverless November 22, 2025 01:14 Inactive
@graphite-app
Copy link
Contributor

graphite-app bot commented Nov 22, 2025

Merge activity

  • Nov 22, 1:14 AM UTC: NathanFlurry added this pull request to the Graphite merge queue.
  • Nov 22, 1:15 AM UTC: CI is running for this pull request on a draft pull request (#3527) due to your merge queue CI optimization settings.
  • Nov 22, 1:15 AM UTC: Merged by the Graphite merge queue via draft PR: #3527.

Copy link
Member Author

NathanFlurry commented Nov 22, 2025

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@claude
Copy link

claude bot commented Nov 22, 2025

PR Review: chore(site): reorg docs

Summary

This PR reorganizes the documentation structure by:

  1. Consolidating deploy options into a new shared data file (deploy/shared.ts)
  2. Adding a new Connect section with deploy platform documentation
  3. Removing several old examples from pnpm-lock.yaml
  4. Simplifying the main docs index page
  5. Reorganizing the sitemap structure

Code Quality & Best Practices ✅

Good:

  • The new deploy/shared.ts file is well-structured with clear TypeScript interfaces (DeployOption, DeployGroup)
  • The specializedPlatform flag is a useful addition for platform-specific filtering
  • Using flatMap to create the backward-compatible deployOptions array is clean and idiomatic
  • The sitemap refactoring properly reuses the deploy groups data to generate sidebar sections dynamically

Suggestions:

  • Consider adding JSDoc comments to the exported interfaces in deploy/shared.ts for better documentation
  • The icon?: any type in DeployOption could be more specific (e.g., IconDefinition from the icons package)

Potential Issues ⚠️

  1. Dead Links in Self-Hosting Docs (self-hosting/index.mdx:38-39):

    • The file references Kubernetes but the sidebar in sitemap/mod.ts does not include this page under the Platforms collapsible section
    • Similarly lists AWS Fargate, Google Cloud Run, Hetzner, VM & Bare Metal without corresponding links
  2. URL Path Mismatch:

    • deploy/shared.ts uses URLs like /docs/deploy/vercel
    • But the sitemap creates a section called Connect at /docs/connect
    • The deploy option URLs do not match the sitemap structure - verify these paths resolve correctly
  3. Typo (self-hosting/index.mdx:6):

    • applciations should be applications

Performance Considerations ✅

  • No performance concerns - this is purely documentation restructuring
  • The lock file changes appropriately remove unused example dependencies

Security Concerns ✅

  • No security concerns - documentation-only changes

Test Coverage

  • N/A for documentation changes
  • Recommend manually verifying all navigation links work after deployment

Minor Observations

  • Large amount of commented-out code in sitemap/mod.ts (lines 148-166, 369-698) - consider removing if no longer needed, or adding TODO comments explaining why it is preserved
  • The connect/index.mdx imports deployGroups but the file path suggests it should be about connecting rather than deploying - the naming may cause confusion

Overall

The reorganization looks reasonable and consolidates deploy options into a maintainable shared data structure. The main concerns are the potential broken links in the self-hosting documentation and URL path consistency. Would recommend verifying all navigation works before merging.

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.

2 participants