-
Notifications
You must be signed in to change notification settings - Fork 152
chore: update exmaples #4162
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: update exmaples #4162
Conversation
Pull Request Review: chore: update examplesThis PR updates example projects with improved documentation, new Vercel deployments, and standardized configurations. Overall, the changes look good but there are a few issues to address. 🟢 Positive ChangesDocumentation Improvements
New Examples
Vercel Deployment Support
🔴 Issues & Concerns1. Typo in PR TitleThe PR title says "update exmaples" but should be "update examples". 2. Missing Vercel Example for per-tenant-databaseAccording to CLAUDE.md, when adding/updating examples, you should ensure vercel equivalents are generated:
The "providers": {}This suggests the Vercel example generation may have failed or wasn't run properly. 3. Inconsistent Package Version ResolutionIn "rivetkit": "workspace:*"to: "rivetkit": "*"According to CLAUDE.md:
While this change aligns with the documented pattern, it's unclear why only these two examples were updated. Should this be applied consistently to all examples? 4. Incomplete Vercel Example GenerationThe import { registry } from "./registry";
registry.start();This looks like the non-Vercel version. According to the pattern in other Vercel examples (e.g., import { Hono } from "hono";
import { registry } from "./actors.ts";
const app = new Hono();
app.all("/api/rivet/*", (c) => registry.handler(c.req.raw));
export default app;5. Extra Blank Lines in READMEsMultiple README files have an unnecessary blank line after the code block (e.g., lines 15, 33, 61, 80, 111, 180, 199, etc.). Example: npm run devFeaturesFeaturesSummaryThis is good work on standardizing and improving the examples. The main blockers are:
Once these are addressed and examples are properly regenerated, this should be ready to merge. |
Merge activity
|
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. ## Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes
d03839f to
b249fff
Compare
e0e274e to
2c75012
Compare
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? Please describe the tests that you ran to verify your changes. ## Checklist: - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes

Description
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist: