docs: update docs-site with OpenChat documentation - #507
Conversation
- Add introduction, quickstart, and architecture overview - Add authentication guide (Better Auth + GitHub OAuth) - Add AI models guide (OpenRouter, BYOK, streaming) - Add self-hosting guides (Docker, environment variables) - Add contributing guide - Update docs.json navigation for OpenChat - Remove Mintlify starter kit placeholder content
|
🚅 Deployed to the openchat-pr-507 environment in OpenChat
|
🚀 Preview Deployment Ready
Convex Preview Backend
🤖 Deployed automatically by GitHub Actions |
Greptile OverviewGreptile SummaryThis PR successfully replaces the Mintlify starter kit with comprehensive OpenChat-specific documentation. The update includes 8 new MDX files covering quickstart, architecture, authentication, AI models, contributing guidelines, and self-hosting instructions, while removing 17 generic starter files. What ChangedAdded Documentation (8 files):
Removed Starter Content (17 files):
Quality AssessmentThe documentation is well-written and technically accurate:
Issues Found1. Broken Link (Line 317 in docker.mdx) - Score: 5/5The Docker guide links to Confidence: Very high - Verified by searching the entire docs-site directory, no dokploy.mdx file exists. 2. Incorrect Environment Variable Prefix (environment.mdx) - Score: 5/5Lines 104-105, 110-111, 114, and 154 use Confidence: Very high - Confirmed by examining Overall AssessmentThis is a high-quality documentation update with only 2 issues (1 broken link, 1 naming error). The content is comprehensive, accurate, and well-structured. The issues are straightforward to fix and don't affect the majority of the documentation. Confidence Score: 4/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
participant Dev as Developer
participant Repo as OpenChat Repo
participant Docs as docs-site/
participant Mint as Mintlify
Dev->>Repo: Clone openchat repository
Dev->>Docs: Replace Mintlify starter content
Dev->>Docs: Add OpenChat-specific guides
Note over Docs: New Content Added
Docs->>Docs: index.mdx (Introduction)
Docs->>Docs: quickstart.mdx (Setup guide)
Docs->>Docs: guides/architecture.mdx
Docs->>Docs: guides/authentication.mdx
Docs->>Docs: guides/ai-models.mdx
Docs->>Docs: guides/contributing.mdx
Docs->>Docs: self-hosting/docker.mdx
Docs->>Docs: self-hosting/environment.mdx
Note over Docs: Old Content Removed
Docs->>Docs: ❌ ai-tools/ (Claude, Cursor, Windsurf)
Docs->>Docs: ❌ api-reference/ (Starter kit examples)
Docs->>Docs: ❌ essentials/ (Generic Mintlify guides)
Docs->>Docs: Update docs.json navigation
Dev->>Mint: Deploy documentation
Mint->>Mint: Render OpenChat docs
Note over Mint,Dev: Issues Found
Mint-->>Dev: ⚠️ Broken link: /self-hosting/dokploy
Mint-->>Dev: ⚠️ Wrong env prefix: NEXT_PUBLIC_
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| <Card title="Environment Variables" icon="gear" href="/self-hosting/environment"> | ||
| Complete environment reference | ||
| </Card> | ||
| <Card title="Dokploy" icon="cloud" href="/self-hosting/dokploy"> |
There was a problem hiding this comment.
The link references /self-hosting/dokploy, but this page doesn't exist in the documentation. You should either:
- Remove this card if Dokploy documentation isn't planned
- Create the missing
docs-site/self-hosting/dokploy.mdxfile - Update the href to point to an existing alternative deployment guide
| <Card title="Dokploy" icon="cloud" href="/self-hosting/dokploy"> | |
| <Card title="Environment Variables" icon="gear" href="/self-hosting/environment"> |
| | `NEXT_PUBLIC_DEV_BYPASS_AUTH` | No | Set to `1` to skip auth (dev only) | | ||
| | `NEXT_PUBLIC_DEV_USER_ID` | No | Mock user ID when bypassing auth | |
There was a problem hiding this comment.
Consistent with the above issue, these environment variable names need to use the VITE_ prefix instead of NEXT_PUBLIC_.
| | `NEXT_PUBLIC_DEV_BYPASS_AUTH` | No | Set to `1` to skip auth (dev only) | | |
| | `NEXT_PUBLIC_DEV_USER_ID` | No | Mock user ID when bypassing auth | | |
| | `VITE_DEV_BYPASS_AUTH` | No | Set to `1` to skip auth (dev only) | | |
| | `VITE_DEV_USER_ID` | No | Mock user ID when bypassing auth | |
|
|
||
| <Step title="Security"> | ||
| - [ ] All secrets in secure secret manager | ||
| - [ ] `NEXT_PUBLIC_DEV_BYPASS_AUTH` removed or set to `0` |
There was a problem hiding this comment.
Update the checklist item to use the correct VITE_ prefix.
| - [ ] `NEXT_PUBLIC_DEV_BYPASS_AUTH` removed or set to `0` | |
| - [ ] `VITE_DEV_BYPASS_AUTH` removed or set to `0` |
| NEXT_PUBLIC_DEV_BYPASS_AUTH=0 | ||
| NEXT_PUBLIC_DEV_USER_ID=dev-user |
There was a problem hiding this comment.
The environment variable prefix is incorrect. OpenChat uses TanStack Start with Vite, not Next.js.
According to apps/web/src/lib/env.ts, the project uses import.meta.env.VITE_* for client-side environment variables. These variables should be renamed from NEXT_PUBLIC_DEV_BYPASS_AUTH and NEXT_PUBLIC_DEV_USER_ID to use the VITE_ prefix instead (e.g., VITE_DEV_BYPASS_AUTH and VITE_DEV_USER_ID).
| | `NEXT_PUBLIC_DEV_USER_ID` | No | Mock user ID when bypassing auth | | ||
|
|
||
| <Warning> | ||
| **NEVER** set `NEXT_PUBLIC_DEV_BYPASS_AUTH=1` in production. This completely disables authentication. |
There was a problem hiding this comment.
Update the variable name in the warning to use the correct VITE prefix instead of NEXT_PUBLIC prefix.
1 participant
Summary
Updates the docs-site subtree with comprehensive OpenChat documentation.
This syncs with the docs repo where PR #1 was already merged.
Changes