Skip to content

Commit df507a5

Browse files
ReasonKit Botclaude
andcommitted
fix: README documentation improvements and test fixes
- Fix version references in reasonkit-core README (v0.1.x, not v1.0) - Add code examples to reasonkit-web README for better usability - Update installation methods to reflect actual available options - Fix LaserLogic circular reasoning detection threshold - Fix DeepSeek benchmark success rate calculation (integer truncation) - Fix PowerCombo mock test assertion (min_confidence threshold) - Various clippy and test improvements across all crates All 1,591 tests passing across reasonkit-core, reasonkit-mem, reasonkit-web 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 65eb4ff commit df507a5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2151
-1823
lines changed

.github/agents/roles/rust-engineer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Before submitting ANY code, verify:
3434
## RESPONSIBILITIES
3535

3636
- Implementing RAG pipelines in `reasonkit-core`.
37-
- Building MCP sidecars in `reasonkit-web-rs`.
37+
- Building MCP sidecars in `reasonkit-web`.
3838
- Optimizing vector search algorithms.
3939
- Writing FFI bindings for Python using `maturin`.
4040

.github/workflows/release.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ jobs:
396396
type=raw,value=latest,enable=${{ needs.validate.outputs.is_prerelease == 'false' }}
397397
labels: |
398398
org.opencontainers.image.title=ReasonKit Core
399-
org.opencontainers.image.description=Rust-first RAG/Knowledge Base Engine with ThinkTools
399+
org.opencontainers.image.description=The Reasoning Engine — Auditable Reasoning for Production AI
400400
org.opencontainers.image.vendor=ReasonKit
401401
org.opencontainers.image.licenses=Apache-2.0
402402
@@ -690,7 +690,7 @@ jobs:
690690
{
691691
"name": "${{ env.NPM_PACKAGE }}",
692692
"version": "${{ needs.validate.outputs.version }}",
693-
"description": "ReasonKit Core - Rust-first RAG/Knowledge Base Engine CLI",
693+
"description": "ReasonKit Core - The Reasoning Engine CLI",
694694
"bin": {
695695
"rk-core": "./bin/rk-core",
696696
"rk": "./bin/rk-core"
@@ -797,7 +797,7 @@ jobs:
797797
cat > npm-package/README.md << 'EOF'
798798
# @reasonkit/cli
799799
800-
ReasonKit Core - Rust-first RAG/Knowledge Base Engine
800+
ReasonKit Core - The Reasoning Engine
801801
802802
## Installation
803803

API_DOCUMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
## Overview
2424

25-
ReasonKit Core is a Rust-first knowledge base and RAG (Retrieval-Augmented Generation) system designed for AI reasoning enhancement. It provides a complete pipeline for document ingestion, embedding, indexing, retrieval, and LLM-powered query answering.
25+
ReasonKit Core is **The Reasoning Engine** — a Rust-native system for auditable, structured AI reasoning. It provides a complete pipeline for document ingestion, embedding, indexing, retrieval, and LLM-powered query answering with ThinkTools protocols.
2626

2727
### Key Features
2828

BRAND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The `brand/` directory contains ~140+ consolidated assets organized by type:
2525
- `diagrams/` - Technical diagrams
2626
- `favicons/` - Favicon sizes
2727
- `avatars/` - Platform avatars
28-
- `readme-assets/` - README images
28+
- `readme/` - README images
2929

3030
---
3131

Dockerfile

Lines changed: 0 additions & 191 deletions
This file was deleted.

0 commit comments

Comments
 (0)