-
Notifications
You must be signed in to change notification settings - Fork 0
Main → Prod #42
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
Main → Prod #42
Changes from all commits
8cceec4
5012216
93391bf
aa31e26
18b02b5
ebb2c8d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # AI Chat Feature - Get your free API keys: | ||
|
|
||
| # Upstash Vector (https://console.upstash.com/vector) | ||
| UPSTASH_VECTOR_REST_URL= | ||
| UPSTASH_VECTOR_REST_TOKEN= | ||
|
|
||
| # Google Gemini (https://aistudio.google.com/apikey) | ||
| GOOGLE_GENERATIVE_AI_API_KEY= |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ Your site will be available at `http://localhost:4321`. | |
| - **Content-First**: Write documentation in MDX with full component support | ||
| - **Framework-Agnostic**: Works with any UI library or none at all | ||
| - **Multiple Content Types**: Documentation, blog posts, and tutorials out of the box | ||
| - **AI Chat Assistant**: Built-in RAG-powered chat that answers questions about your docs | ||
| - **Static Site Generation**: Fast, SEO-friendly pages that deploy anywhere | ||
| - **Type-Safe**: Full TypeScript support with Astro Content Collections | ||
| - **Dark Mode**: Automatic dark mode support via CSS media queries | ||
|
|
@@ -31,6 +32,8 @@ Your site will be available at `http://localhost:4321`. | |
| - [MDX](https://mdxjs.com/) - Markdown with components | ||
| - [TypeScript](https://www.typescriptlang.org/) - Type safety | ||
| - [Tailwind CSS](https://tailwindcss.com/) - Styling | ||
| - [Google Gemini](https://ai.google.dev/) - AI chat responses | ||
| - [Upstash Vector](https://upstash.com/vector) - Vector search for RAG | ||
| - [Storybook](https://storybook.js.org/) - Component playground (optional) | ||
|
|
||
| ## Installation | ||
|
|
@@ -271,6 +274,43 @@ import Example from '../../components/Example.astro'; | |
| </Example> | ||
| ``` | ||
|
|
||
| ## AI Chat Assistant | ||
|
|
||
| DocuBase includes a built-in AI chat assistant that uses RAG (Retrieval-Augmented Generation) to answer questions about your documentation. | ||
|
|
||
| ### Setup | ||
|
|
||
| 1. Copy the environment file: | ||
|
|
||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 2. Add your API keys to `.env`: | ||
|
|
||
| ```env | ||
| # Upstash Vector (https://console.upstash.com/vector) | ||
| UPSTASH_VECTOR_REST_URL=your_url_here | ||
| UPSTASH_VECTOR_REST_TOKEN=your_token_here | ||
|
|
||
| # Google Gemini (https://aistudio.google.com/apikey) | ||
| GOOGLE_GENERATIVE_AI_API_KEY=your_key_here | ||
| ``` | ||
|
|
||
| 3. That's it! Content is automatically indexed on every build. | ||
|
|
||
| ### How It Works | ||
|
|
||
| - Content is automatically indexed when you run `pnpm run build` | ||
| - Users can ask questions via the chat widget or "Ask Anything" input | ||
| - The AI searches your docs and provides relevant answers with sources | ||
| - No manual indexing required - just write docs and deploy | ||
|
Comment on lines
+300
to
+307
|
||
|
|
||
| ### Components | ||
|
|
||
| - **AskAnything**: Homepage input for starting a chat | ||
| - **ChatWidget**: Floating chat button (can be added to any layout) | ||
|
|
||
| ## Storybook (Optional) | ||
|
|
||
| DocuBase includes an optional Storybook setup for developing and showcasing components: | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,12 +5,14 @@ import { fileURLToPath } from 'node:url'; | |||||
|
|
||||||
| import tailwindcss from '@tailwindcss/vite'; | ||||||
| import mdx from '@astrojs/mdx'; | ||||||
| import vercel from '@astrojs/vercel'; | ||||||
|
|
||||||
| const __dirname = path.dirname(fileURLToPath(import.meta.url)); | ||||||
|
|
||||||
| export default defineConfig({ | ||||||
| site: 'https://docubase-docs.vercel.app', | ||||||
| output: 'static', | ||||||
|
||||||
| output: 'static', | |
| output: 'hybrid', |
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 1.2.0 changelog entry repeats the same bullet twice (both keyed to
8cceec4). This looks like an accidental duplicate and makes the changelog noisy; remove the redundant line or replace it with distinct information.