@devilsdev/rag-pipeline-utils 2.0.1 → 2.1.1

package/docs-site/docs/Tutorials.md

@@ -0,0 +1,106 @@
+---
+id: Tutorials
+title: Tutorials & Onboarding
+sidebar_label: Tutorials
+---
+
+Welcome to the **RAG Pipeline Utils** tutorial section. These guides will help developers quickly onboard, integrate, and extend the modular RAG system.
+
+---
+
+##  1. Install the Package
+
+```bash
+npm install @devilsdev/rag-pipeline-utils
+```
+
+---
+
+## 2. Ingest Documents Using CLI
+
+This CLI command loads PDFs, embeds them, and stores the vectors.
+
+```bash
+npx rag-utils ingest ./sample.pdf --config .ragrc.json
+```
+
+Ensure you have a valid `.ragrc.json` config:
+
+```json
+{
+  "loader": { "pdf": "./src/mocks/pdf-loader.js" },
+  "embedder": { "openai": "./src/mocks/openai-embedder.js" },
+  "retriever": { "pinecone": "./src/mocks/pinecone-retriever.js" },
+  "llm": { "openai": "./src/mocks/openai-llm.js" },
+  "namespace": "docs-example",
+  "pipeline": ["loader", "embedder", "retriever"]
+}
+```
+
+---
+
+## 3. Run a Query Using CLI
+
+```bash
+npx rag-utils query "What is this document about?" --config .ragrc.json
+```
+
+---
+
+## 4. Register a Custom Plugin
+
+You can create your own loader/retriever/LLM:
+
+```js
+// src/plugins/my-custom-llm.js
+export default class MyCustomLLM {
+  ask(prompt) {
+    return `Custom response to: ${prompt}`;
+  }
+}
+```
+
+Then reference it in `.ragrc.json`:
+
+```json
+"llm": {
+  "custom": "./src/plugins/my-custom-llm.js"
+}
+```
+
+---
+
+## 5. Validate Plugin Mocks
+
+Ensure all mocks meet contract interfaces before commit:
+
+```bash
+npm run validate-fixtures
+```
+
+---
+
+## 6. Run All Tests + Coverage
+
+```bash
+npm run ci
+```
+
+This runs:
+
+-  Linting
+-  Fixture validation
+-  Unit/integration tests
+-  Coverage reporting
+
+---
+
+## Next Steps
+
+- Explore `/src/core/plugin-registry.js` for plugin orchestration
+- Browse `/scripts/` for CI and release utilities
+- View `/__tests__/` for end-to-end RAG validation flows
+
+---
+
+Looking to build on top of this? Check out [Use Cases](./Use-Cases.md) for advanced scenarios.

package/docs-site/docs/Usage.md

@@ -4,7 +4,7 @@ This guide covers how to use `@yourorg/rag-pipeline-utils` programmatically via
 
 ---
 
-## 📦 Installation
+## Installation
 
 ```bash
 npm install @yourorg/rag-pipeline-utils
@@ -12,7 +12,7 @@ npm install @yourorg/rag-pipeline-utils
 
 ---
 
-## 🔧 Programmatic API
+## Programmatic API
 
 Import and instantiate a RAG pipeline:
 
@@ -33,14 +33,14 @@ console.log(answer);
 
 ---
 
-## 🔁 Pipeline Methods
+##  Pipeline Methods
 
 - `pipeline.ingest(path: string)` → Load, chunk, embed, and store vectors
 - `pipeline.query(prompt: string)` → Retrieve context, rerank (optional), and call LLM
 
 ---
 
-## 🧩 Plugin Configuration
+##  Plugin Configuration
 
 You can customize the pipeline by registering plugins:
 
@@ -51,7 +51,7 @@ registry.register('retriever', 'opensearch', new MyOpenSearchRetriever());
 
 ---
 
-## ⚙️ Configuration via `.ragrc.json`
+## Configuration via `.ragrc.json`
 
 Create a JSON file at your root:
 

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,6 +12,7 @@ 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',
 
@@ -34,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: {
@@ -45,7 +47,6 @@ export default {
 
   organizationName: 'DevilsDev',
   projectName: 'rag-pipeline-utils',
-  deploymentBranch: 'gh-pages',
 
   presets: [
     [