Skip to content
This repository was archived by the owner on Jan 13, 2025. It is now read-only.

Commit b465d7b

Browse files
authoredJan 2, 2025
Merge pull request #250 from Cloud-Code-AI/248-increase-nav-sidebar-width-so-that-more-words-can-be-accustomed
fix: updated the docs based on new updates
2 parents 5d54988 + 21a02c8 commit b465d7b

File tree

9 files changed

+446
-2130
lines changed

9 files changed

+446
-2130
lines changed
 

‎docs/.cfignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.next/cache/
2+
node_modules/

‎docs/README.md

+27-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
<p align="center">
32
<h1 align="center">AkiraDocs</h1>
43
</p>
@@ -36,6 +35,33 @@
3635
AkiraDocs is a modern documentation platform that combines the power of AI with a Notion-like editing experience. Create, translate, and optimize your documentation automatically while maintaining complete control over the content. Perfect for teams who want to focus on their ideas rather than the complexities of documentation management.
3736

3837

38+
## 📚 WebRAG Documentation Search
39+
40+
AkiraDocs implements a fully client-side RAG (Retrieval Augmented Generation) system that enables unlimited AI chat interactions without any API costs or rate limits.
41+
42+
### How it Works
43+
44+
1. **Offline Indexing**: Documentation is processed and embedded during build time using GTE-small model
45+
2. **Browser-Based Components**:
46+
- SQLite database (stored in browser) for vector search
47+
- Local embedding model for query processing
48+
- Local LLaMA model for response generation
49+
- All processing happens directly in the user's browser
50+
51+
### Key Benefits
52+
53+
-**No API Costs**: Everything runs locally in the browser
54+
- 🚀 **Unlimited Chats**: No rate limits or usage restrictions
55+
- 🔒 **Privacy-First**: No data leaves the user's device
56+
-**Low Latency**: Direct local processing after initial model load
57+
58+
### Technical Stack
59+
60+
- Embedding: `sauravpanda/gte-small-onnx`
61+
- LLM: `Llama-3.2-1B-Instruct`
62+
- Storage: `sql.js-httpvfs` for SQLite in browser
63+
64+
3965
## ⚡️ Quick Deploy
4066
Get started in seconds:
4167

0 commit comments

Comments
 (0)