-
Notifications
You must be signed in to change notification settings - Fork 1
Added Vercel to a new Integrations section #6
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What Changed
This PR introduces a new "Integrations" section to the documentation and adds a comprehensive guide for deploying Kernel applications on Vercel. A new page, integrations/vercel.mdx
, details the process using a dedicated template, covering everything from initial setup and API key configuration to the project's monorepo structure. This is a great addition that provides a clear path for users to deploy their applications on a popular platform.
Risks / Concerns
Overall, this is a solid contribution. There are a couple of minor inconsistencies in the new documentation that could be polished to prevent user confusion:
- In
integrations/vercel.mdx
, a link on line 73 points to a local file path ([route](packages/web/app/api/chat/route.ts)
) instead of a documentation page. - The repository name is inconsistent between the
git clone
command and the directory structure example (line 15 vs. line 48).
2 files reviewed | 2 comments | Review on Mesa | Edit Reviewer Settings
- [AI SDK](https://ai-sdk.dev) for AI integration | ||
- [Assistant-UI](https://github.com/assistant-ui/assistant-ui) for the chat interface | ||
|
||
The chatbot is deployed as a [route](packages/web/app/api/chat/route.ts) and uses the `browserAgentTool` to control the browser. You can extend this to build custom chatbots with your own tools. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link text [route](packages/web/app/api/chat/route.ts)
appears to be referencing a file path within the template repository rather than a documentation link. This might be confusing for users since it's not a clickable link to actual documentation. Consider either removing the link formatting or linking to relevant documentation about routes.
Type: Logic | Severity: Low
The template is organized as a monorepo with two main packages: | ||
|
||
``` | ||
kernel-vercel-template/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor inconsistency: The directory structure shows kernel-vercel-template/
but the git clone command above (line 15) clones vercel-template.git
. Consider ensuring the naming is consistent throughout the documentation.
Type: Logic | Severity: Low
Description
Please provide an explanation of the changes you've made:
[Describe what this PR does and why]
Implementation Checklist
Testing
mintlify dev
works (see installation here)Docs
Visual Proof
Please provide a screenshot or video demonstrating that your changes work locally:
[Drag and drop your screenshot/video here or use the following format:]
]
[
Related Issue
Fixes [Github issue link]
[If this corresponds to a fix from another Kernel OSS repo, include this:]
Fixes [Link to other repo]
[Replace with actual issue link, e.g., Fixes https://github.com/username/repo/issues/123]
Additional Notes
[Any additional context, concerns, or notes for reviewers]
TL;DR
Added a new 'Integrations' section to the documentation, featuring a detailed guide for deploying Kernel applications with Vercel.
Why we made these changes
To provide clear instructions and a pre-configured template for users to easily deploy Kernel applications on Vercel, enhancing integration capabilities.
What changed?
Validation
mintlify dev
works locally.