Skip to content

Open source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base

overall cleaning

Hugo Richardccf09c54ad23
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
index a0eb66f..31ef72f 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.yml
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -30,7 +30,10 @@ body:
attributes:
label: Reproduction
description: A reproduction is strongly encouraged, to help us identify the issue and fix it. You can use a code sandbox or a repository to reproduce the issue.
- placeholder: https://stackblitz.com/edit/savoir
+ placeholder: |
+ 1. Clone the repo and follow the Quick Start in README
+ 2. Describe the minimal steps to reproduce the issue
+ 3. Or link to a CodeSandbox/StackBlitz if applicable
validations:
required: true
- type: textarea
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..24946fd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+ - name: GitHub Discussions
+ url: https://github.com/vercel-labs/savoir/discussions
+ about: Ask questions and discuss ideas with the community
diff --git a/.gitignore b/.gitignore
index cff7ac8..d3dff82 100644
--- a/.gitignore
+++ b/.gitignore
@@ -29,8 +29,6 @@ node_modules
.swc*
.workflow-data*
-apps/web/.data
apps/app/.data
-apps/bot/.data
.vercel
.env*.local
diff --git a/README.md b/README.md
index 67749b8..a4dad26 100644
--- a/README.md
+++ b/README.md
@@ -4,18 +4,18 @@
<br>
<b>Savoir</b>
<br>
- <i>Build AI agents with up-to-date knowledge access.</i>
+ <i>Open source file-system and knowledge based agent template.</i>
<br>
<br>
</p>
<p align="center">
- <b>Template.</b> Fork it, customize it, and deploy your own AI documentation assistant.
+ <b>Template.</b> Fork it, customize it, and deploy your own file-system based AI agent.
</p>
---
-Open-source infrastructure to build AI agents powered by up-to-date file-based knowledge. Plug any source — GitHub repos, YouTube transcripts, custom APIs — and deploy as a chat app, a GitHub bot, a Discord bot, or all at once.
+Open source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base — grep, find, and cat across your sources, no embeddings, no vector DB. Plug any source (GitHub repos, YouTube transcripts, custom APIs) and deploy as a chat app, a GitHub bot, a Discord bot, or all at once.
## Features
@@ -25,7 +25,7 @@ No vector database. No chunking pipeline. No embedding model. Savoir agents use
### Multi-Platform Bots — One Agent, Everywhere
-Write your agent once, deploy it on the web chat, GitHub Issues, Discord — and soon Slack, Linear, and more. Powered by pluggable adapters via the [Chat SDK](https://github.com/vercel-labs/chat). Adding a new platform is [a single adapter file](./docs/CUSTOMIZATION.md#4-add-a-bot-adapter).
+Write your agent once, deploy it on the web chat, GitHub Issues, Discord - and soon Slack, Linear, and more. Powered by pluggable adapters via the [Chat SDK](https://github.com/vercel-labs/chat). Adding a new platform is [a single adapter file](./docs/CUSTOMIZATION.md#4-add-a-bot-adapter).
### Built-in Admin Panel
@@ -37,7 +37,7 @@ Ask your app about itself. "What errors happened in the last 24 hours?", "Show t
### Smart Complexity Router
-Every incoming question is classified by complexity (trivial → complex) and [routed to the right model](./docs/ARCHITECTURE.md#4-ai-agent-router--model-selection). Simple questions go to fast, cheap models. Hard questions go to powerful ones. Cost optimization happens automatically — no manual rules to maintain.
+Every incoming question is classified by complexity (trivial → complex) and [routed to the right model](./docs/ARCHITECTURE.md#4-ai-agent-router--model-selection). Simple questions go to fast, cheap models. Hard questions go to powerful ones. Cost optimization happens automatically, no manual rules to maintain.
### Real-Time Tool Visualization
diff --git a/apps/app/app/app.config.ts b/apps/app/app/app.config.ts
index 13edca0..c76b8f1 100644
--- a/apps/app/app/app.config.ts
+++ b/apps/app/app/app.config.ts
@@ -1,7 +1,7 @@
export default defineAppConfig({
app: {
name: 'Savoir',
- description: 'Your intelligent AI assistant for knowledge and insights.',
+ description: 'Open source file-system and knowledge based agent template.',
icon: 'i-custom-savoir',
},
ui: {
diff --git a/apps/app/app/pages/login.vue b/apps/app/app/pages/login.vue
index 3244280..5c4588e 100644
--- a/apps/app/app/pages/login.vue
+++ b/apps/app/app/pages/login.vue
@@ -5,7 +5,20 @@ import { Circle, DotGrid, Glow, ProgressiveBlur, Saturation, Shader, Swirl } fro
const appConfig = useAppConfig()
definePageMeta({ layout: false, auth: 'guest' })
-useSeoMeta({ title: 'Sign in' })
+
+const config = useRuntimeConfig()
+const siteUrl = config.public.siteUrl as string
+const ogImage = siteUrl ? `${siteUrl.replace(/\/$/, '')}/og.jpg` : '/og.jpg'
+
+useSeoMeta({
+ title: 'Sign in',
+ description: appConfig.app.description,
+ ogTitle: appConfig.app.name,
+ ogDescription: appConfig.app.description,
+ ogImage,
+ twitterImage: ogImage,
+ twitterCard: 'summary_large_image',
+})
const route = useRoute()
const mode = ref<'signin' | 'signup'>('signin')
diff --git a/apps/app/package.json b/apps/app/package.json
index 4a9b1ff..d717800 100644
--- a/apps/app/package.json
+++ b/apps/app/package.json
@@ -2,6 +2,7 @@
"name": "@savoir/app",
"private": true,
"license": "MIT",
+ "description": "Unified Nuxt app for Savoir (chat UI, API, bots)",
"type": "module",
"scripts": {
"build": "nuxt build",
diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md
index 874dbb4..5b01b38 100644
--- a/docs/ARCHITECTURE.md
+++ b/docs/ARCHITECTURE.md
@@ -2,7 +2,7 @@
> Back to [README](../README.md)
-This document describes the technical architecture of Savoir, a platform for building AI agents with up-to-date knowledge access.
+This document describes the technical architecture of Savoir, an open-source file-system and knowledge based agent template for building AI agents with up-to-date knowledge access.
## System Overview
diff --git a/docs/CUSTOMIZATION.md b/docs/CUSTOMIZATION.md
index 3ae1b83..c188ec4 100644
--- a/docs/CUSTOMIZATION.md
+++ b/docs/CUSTOMIZATION.md
@@ -27,7 +27,7 @@ Edit `apps/app/app/app.config.ts` to change the branding:
export default defineAppConfig({
app: {
name: 'My Assistant',
- description: 'AI assistant for my documentation.',
+ description: 'Open source file-system and knowledge based agent template.',
icon: 'i-custom-savoir', // Replace with your own icon
},
// ...
diff --git a/package.json b/package.json
index 8d85829..abad42e 100644
--- a/package.json
+++ b/package.json
@@ -3,7 +3,7 @@
"private": true,
"type": "module",
"license": "MIT",
- "description": "Monorepo for Savoir",
+ "description": "Open source file-system and knowledge based agent template",
"author": "HugoRCD",
"repository": {
"type": "git",
diff --git a/packages/agent/package.json b/packages/agent/package.json
index 37cd8be..81cad47 100644
--- a/packages/agent/package.json
+++ b/packages/agent/package.json
@@ -3,6 +3,15 @@
"version": "0.1.0",
"license": "MIT",
"description": "Framework-agnostic agent core for Savoir",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/vercel-labs/savoir.git",
+ "directory": "packages/agent"
+ },
+ "bugs": {
+ "url": "https://github.com/vercel-labs/savoir/issues"
+ },
+ "homepage": "https://github.com/vercel-labs/savoir/tree/main/packages/agent#readme",
"type": "module",
"exports": {
".": {
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index ceebc4d..c974953 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,7 +1,7 @@
{
"name": "@savoir/sdk",
"version": "0.1.0-alpha.2",
- "description": "SDK for Savoir documentation AI with AI SDK compatible tools",
+ "description": "AI SDK compatible tools for file-system and knowledge-based agents",
"license": "MIT",
"author": "Hugo Richard",
"repository": {