Skip to content

Commit fa95347

Browse files
docs: ensure accuracy and remove unverifiable claims from v2.3.1 documentation
- Remove fabricated performance benchmarks and replace with general guidance - Remove all emojis from code examples and documentation - Remove unverifiable "Since: vX.X.X" version tags from API methods - Simplify CHANGELOG to only list verifiable v2.3.1 features - Remove future timeline predictions and deprecation warnings All documentation now reflects only verified, honest information about v2.3.1. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 4a58670 commit fa95347

File tree

4 files changed

+74
-323
lines changed

4 files changed

+74
-323
lines changed

docs-site/versioned_docs/version-2.3.1/API-Reference.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ Comprehensive reference documentation for RAG Pipeline Utils v2.3.1.
1212

1313
Creates a RAG pipeline instance with the specified plugins.
1414

15-
> **Since:** v2.0.0
16-
> **Behavior:** Factory function that initializes a complete RAG pipeline by composing loader, embedder, retriever, and LLM components. Supports both plugin instances and string references to registered plugins.
15+
**Behavior:** Factory function that initializes a complete RAG pipeline by composing loader, embedder, retriever, and LLM components. Supports both plugin instances and string references to registered plugins.
1716

1817
**Signature:**
1918

@@ -38,7 +37,6 @@ function createRagPipeline(config: PipelineConfig): Pipeline;
3837
**Example:**
3938

4039
```javascript
41-
// 📦 Available since v2.0.0
4240
const { createRagPipeline } = require("@devilsdev/rag-pipeline-utils");
4341

4442
const pipeline = createRagPipeline({
@@ -51,9 +49,7 @@ const pipeline = createRagPipeline({
5149

5250
**Aliases:**
5351

54-
- `createPipeline` - Backward compatibility alias
55-
56-
> ⚠️ **Deprecated in v2.3.0:** Use `createRagPipeline` instead. `createPipeline` will be removed in v3.0.0.
52+
- `createPipeline` - Backward compatibility alias (deprecated, use `createRagPipeline` instead)
5753

5854
---
5955

@@ -63,8 +59,7 @@ const pipeline = createRagPipeline({
6359

6460
Executes a query against the RAG pipeline.
6561

66-
> **Since:** v2.0.0
67-
> **Behavior:** Processes natural language queries through the complete RAG flow: embeds query → retrieves relevant documents → generates contextual response using LLM. Supports both standard and streaming response modes.
62+
**Behavior:** Processes natural language queries through the complete RAG flow: embeds query, retrieves relevant documents, and generates contextual response using LLM. Supports both standard and streaming response modes.
6863

6964
**Signature:**
7065

@@ -110,7 +105,6 @@ console.log(result.sources);
110105
**Streaming Example:**
111106

112107
```javascript
113-
// 🌊 Streaming support added in v2.0.0
114108
const stream = await pipeline.query("Explain the benefits", {
115109
stream: true,
116110
});
@@ -126,8 +120,7 @@ for await (const chunk of stream) {
126120

127121
Ingests documents into the RAG pipeline.
128122

129-
> **Since:** v2.0.0
130-
> **Behavior:** Loads documents from file paths or directories, chunks content, generates embeddings, and stores them in the vector database. Supports batch processing with configurable concurrency and retry logic.
123+
**Behavior:** Loads documents from file paths or directories, chunks content, generates embeddings, and stores them in the vector database. Supports batch processing with configurable concurrency and retry logic.
131124

132125
**Signature:**
133126

@@ -215,8 +208,7 @@ function normalizeConfig(config: Partial<RagConfig>): RagConfig;
215208

216209
Enterprise-grade JWT validation with replay protection.
217210

218-
> **Since:** v2.2.0
219-
> **Behavior:** Provides cryptographically secure JWT signing and verification with built-in replay attack detection, algorithm confusion prevention, and race condition mitigation. Supports both self-signed (reusable) and external (single-use) token validation.
211+
**Behavior:** Provides cryptographically secure JWT signing and verification with built-in replay attack detection, algorithm confusion prevention, and race condition mitigation. Supports both self-signed (reusable) and external (single-use) token validation.
220212

221213
**Constructor:**
222214

@@ -250,7 +242,6 @@ sign(payload: object, options?: SignOptions): string
250242
**Example:**
251243

252244
```javascript
253-
// 🔒 Security features added in v2.2.0 (Enterprise Edition)
254245
const { JWTValidator } = require("@devilsdev/rag-pipeline-utils");
255246

256247
const validator = new JWTValidator({
@@ -259,7 +250,7 @@ const validator = new JWTValidator({
259250
issuer: "my-app",
260251
audience: "api-users",
261252
strictValidation: true,
262-
enableJtiTracking: true, // Replay protection (v2.3.1)
253+
enableJtiTracking: true, // Replay protection
263254
});
264255

265256
const token = validator.sign({
@@ -308,8 +299,7 @@ try {
308299

309300
Multi-layer input sanitization with path traversal defense.
310301

311-
> **Since:** v2.2.0
312-
> **Behavior:** Protects against XSS, SQL injection, command injection, and path traversal attacks through multi-layer validation. Uses iterative URL decoding (up to 5 iterations) to detect sophisticated encoding-based attacks.
302+
**Behavior:** Protects against XSS, SQL injection, command injection, and path traversal attacks through multi-layer validation. Uses iterative URL decoding (up to 5 iterations) to detect sophisticated encoding-based attacks.
313303

314304
**Constructor:**
315305

@@ -385,8 +375,7 @@ try {
385375

386376
Process text, images, audio, and video content with unified embedding pipelines.
387377

388-
> **Since:** v2.2.0 (Enterprise Edition)
389-
> **Behavior:** Handles multi-modal content (text, images, audio, video) through unified embedding generation. Automatically selects appropriate models based on content type and normalizes embeddings for cross-modal retrieval.
378+
**Behavior:** Handles multi-modal content (text, images, audio, video) through unified embedding generation. Automatically selects appropriate models based on content type and normalizes embeddings for cross-modal retrieval.
390379

391380
**Constructor:**
392381

@@ -461,8 +450,7 @@ await engine.learn({
461450

462451
Execute complex RAG workflows as directed acyclic graphs.
463452

464-
> **Since:** v2.1.0
465-
> **Behavior:** Orchestrates complex multi-step workflows as directed acyclic graphs with automatic dependency resolution, parallel execution of independent tasks, and comprehensive error handling with retry logic.
453+
**Behavior:** Orchestrates complex multi-step workflows as directed acyclic graphs with automatic dependency resolution, parallel execution of independent tasks, and comprehensive error handling with retry logic.
466454

467455
**Constructor:**
468456

@@ -493,7 +481,6 @@ async execute(input?: any): Promise<DAGResult>
493481
**Example:**
494482

495483
```javascript
496-
// 🔀 DAG workflow engine added in v2.1.0
497484
const { DAGEngine } = require("@devilsdev/rag-pipeline-utils");
498485

499486
const dag = new DAGEngine();

0 commit comments

Comments
 (0)