v0.3.33: update copilot docs #1050
Conversation
…tions (#1043) * Docs * Lint
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Greptile Summary
This PR improves the documentation for self-hosting Copilot, which is Sim's managed AI assistant service. The changes address a critical gap in the existing self-hosting instructions by providing clear, step-by-step guidance for users deploying their own instances.
The main documentation update transforms a single-line instruction into a comprehensive 3-step process: (1) generating a Copilot API key from the hosted sim.ai application, (2) setting the COPILOT_API_KEY environment variable in the self-hosted deployment, and (3) configuring public DNS access with proper environment variables (NEXT_PUBLIC_APP_URL and BETTER_AUTH_URL). The addition of ngrok as an example solution demonstrates practical consideration for developers who need public access during development.
Two supporting technical changes accompany this documentation update. The main README.md now includes the DNS requirement as a bullet point in the self-hosting section, ensuring visibility at the repository level. Additionally, the Next.js configuration has been updated to allow remote images from Google User Content (lh3.googleusercontent.com), likely to support any Google-hosted imagery that may be referenced in the updated documentation.
These changes integrate well with Sim's existing architecture as a monorepo platform. The Copilot service operates as an external managed service that needs to communicate back to user instances, explaining why public accessibility is essential. The environment variable requirements align with Sim's existing authentication patterns using Better Auth, and the configuration changes follow established patterns for adding trusted remote image sources.
Confidence score: 5/5
- This PR is safe to merge with minimal risk as it consists entirely of documentation improvements and minor configuration updates
- Score reflects straightforward changes that enhance user experience without modifying core application logic or introducing breaking changes
- No files require special attention - all changes are well-structured and follow established patterns
3 files reviewed, no comments
Summary
Type of Change