@devilsdev/rag-pipeline-utils 2.0.0 → 2.1.0

package/docs-site/docs/Use-Cases.md

@@ -0,0 +1,77 @@
+---
+id: Use-Cases
+title: Real-World Use Cases
+sidebar_position: 5
+---
+
+##  Real-World Applications of RAG Pipeline Utils
+
+This project goes beyond traditional RAG tools — it’s a **developer-focused modular framework**. Here's how it’s used:
+
+---
+
+### 1. Customizable LLM Workflows
+
+**Use Case:** A team wants to test three different retrievers (Pinecone, Weaviate, Redis) and switch LLMs dynamically during eval.
+
+```bash
+rag-utils ingest sample.pdf --retriever pinecone --llm openai
+```
+
+---
+
+### 2. Plugin-Based Evaluation Benchmarks
+
+**Use Case:** You want to run BLEU/ROUGE scoring across prompt templates or documents using CLI:
+
+```bash
+rag-utils evaluate --dataset tests/eval.json --llm anthropic
+```
+
+---
+
+### 3. Internal LLM System for SaaS
+
+**Use Case:** Embed RAG processing into a backend:
+
+```js
+import { PluginRegistry, runPipeline } from 'rag-pipeline-utils';
+
+const registry = new PluginRegistry();
+registry.register('embedder', 'openai', new OpenAIEmbedder());
+
+const output = await runPipeline({
+  loader: 'pdf',
+  retriever: 'pinecone',
+  llm: 'openai',
+  query: 'How does this work?'
+});
+```
+
+---
+
+### 4. GitHub + NPM Automation for ML Pipelines
+
+**Use Case:** You want a release blog post + versioned package published automatically:
+
+- Commit code
+- Push to `main`
+- GitHub Action triggers:
+  - Semantic release
+  - CHANGELOG update
+  - Blog post generation
+  - NPM publish
+
+---
+
+###  Benefits
+
+- **Pluggable** components via clean interfaces
+- **CLI + programmatic** access for flexible DX
+- **CI-validated** plugin contract enforcement
+- **Docs-first** developer onboarding
+- **Production-ready** for real ML teams
+
+---
+
+> Want to contribute your use case? PRs welcome on [GitHub](https://github.com/DevilsDev/rag-pipeline-utils).

package/docs-site/docs/components/BlogCardExample.mdx

@@ -0,0 +1,7 @@
+import BlogCard from '@site/src/components/BlogCard';
+
+# 📸 BlogCard Demo
+
+Here's how a typical BlogCard component appears when used with a cached LQIP-enabled image:
+
+<BlogCard title="Composable Pipelines in RAG" image="img_hero.jpg" />

package/docs-site/docusaurus.config.js

@@ -12,12 +12,20 @@ export default {
   tagline: 'Composable RAG pipelines with Node.js',
   url: 'https://devilsdev.github.io',
   baseUrl: '/rag-pipeline-utils/',
+  deploymentBranch: 'gh-pages',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
 
   // ✅ Final favicon and social card for branding
   favicon: 'img/favicon.ico',
   themeConfig: {
+    
+    // algolia: {
+    //   appId: 'YOUR_APP_ID',
+    //   apiKey: 'YOUR_PUBLIC_API_KEY',
+    //   indexName: 'rag_pipeline_utils',
+    //   contextualSearch: true,
+    // },
     image: 'img/social-card.jpg',
     navbar: {
       title: 'RAG Utils',
@@ -27,7 +35,8 @@ export default {
       },
       items: [
         { to: '/docs/Introduction', label: 'Docs', position: 'left' },
-        { href: 'https://github.com/DevilsDev/rag-pipeline-utils', label: 'GitHub', position: 'right' }
+        { to: '/blog', label: 'Blog', position: 'left' },
+        { href: 'https://github.com/DevilsDev/rag-pipeline-utils', label: 'GitHub', position: 'right' },
       ]
     },
     footer: {
@@ -38,7 +47,6 @@ export default {
 
   organizationName: 'DevilsDev',
   projectName: 'rag-pipeline-utils',
-  deploymentBranch: 'gh-pages',
 
   presets: [
     [
@@ -48,6 +56,12 @@ export default {
           sidebarPath: require.resolve('./sidebars.js'),
           editUrl: 'https://github.com/DevilsDev/rag-pipeline-utils/edit/main/docs-site/'
         },
+
+        blog: {
+          showReadingTime: true,
+          editUrl: 'https://github.com/DevilsDev/rag-pipeline-utils/edit/main/docs-site/blog/',
+        },
+        
         theme: {
           customCss: require.resolve('./src/css/custom.css')
         }