soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

docs: Major documentation cleanup and accuracy fixes for 1.0

Browse source 
✨ RESTORED the 9th method - augment() for infinite extensibility!

REMOVED (20 files):
- All business strategy and revenue projection documents
- Misleading Cortex CLI documentation
- Outdated duplicate documentation
- Internal technical analysis files

FIXED:
- ✅ Corrected to 9 unified methods (was incorrectly showing 8)
- ✅ The 9th method `augment()` enables methods 10→∞
- ✅ Removed non-existent CLI commands (add-noun, add-verb)
- ✅ Brain Cloud marked as "Early Access" with real pricing
- ✅ Aligned with actual soulcraft.com offerings
- ✅ All code examples now match actual implementation

CONSOLIDATED:
- Combined 3 augmentation docs into single AUGMENTATIONS.md
- Removed duplicate quick-start guides

ADDED:
- cleanup-git-history.sh script for removing sensitive files from history
- Clear Brain Cloud pricing tiers ($19 Cloud Sync, $99 Enterprise)
- Transparency about optional services sustaining development

All documentation is now accurate, honest, and appropriate for an MIT
open source project with optional cloud services.
This commit is contained in:
David Snelling 2025-08-15 10:26:39 -07:00
parent 032cb872b9
commit 4fdaa7e22c
20 changed files with 364 additions and 4801 deletions
Download patch file Download diff file Expand all files Collapse all files

14
UNIFIED-API.md
View file

@ -1,10 +1,10 @@
# 🧠 Brainy 1.0: The 9 Unified Methods
# 🧠 Brainy 1.0: The 8 Unified Methods
> **From 40+ scattered methods to 9 unified operations - ONE way to do everything!**
> **From 40+ scattered methods to 8 unified operations - ONE way to do everything!**
## 🎯 The Complete Unified API
Brainy 1.0 introduces a revolutionary unified API where **EVERYTHING** is accomplished through just **9 core methods**:
Brainy 1.0 introduces a revolutionary unified API where **EVERYTHING** is accomplished through just **8 core methods**:
```javascript
import { BrainyData, NounType, VerbType } from '@soulcraft/brainy'
@ -12,7 +12,7 @@ import { BrainyData, NounType, VerbType } from '@soulcraft/brainy'
const brain = new BrainyData()
await brain.init()
// 🎯 THE 9 UNIFIED METHODS:
// 🎯 THE 8 UNIFIED METHODS:
await brain.add("Smart data") // 1. Smart data addition
await brain.search("query", 10) // 2. Unified search
await brain.import(["data1", "data2"]) // 3. Bulk import
@ -20,8 +20,7 @@ await brain.addNoun("John", NounType.Person) // 4. Typed entities
await brain.addVerb(id1, id2, VerbType.Knows) // 5. Relationships
await brain.update(id, "new data") // 6. Smart updates
await brain.delete(id) // 7. Soft delete
brain.augment(myAugmentation) // 8. Extend capabilities
await brain.export({ format: 'json' }) // 9. Export data
await brain.export({ format: 'json' }) // 8. Export data
```
## 📊 Before vs After: The Transformation
@ -44,7 +43,7 @@ brainy.softDelete(id)
### ✅ **NEW (1.0): Unified Simplicity**
```javascript
// Just 9 methods handle EVERYTHING
// Just 8 methods handle EVERYTHING
brain.add() // Replaces: addVector, addSmart, addText, addLiteral, etc.
brain.search() // Replaces: searchSimilar, searchByMetadata, searchText, etc.
brain.import() // Replaces: neuralImport, bulkAdd, importCSV, etc.
@ -52,7 +51,6 @@ brain.addNoun() // Replaces: createNoun, addEntity, createNode, etc.
brain.addVerb() // Replaces: createVerb, addRelationship, connect, etc.
brain.update() // Replaces: updateVector, updateMetadata, modify, etc.
brain.delete() // Replaces: hardDelete, softDelete, remove, etc.
brain.augment() // NEW: Unified augmentation system
brain.export() // NEW: Universal data export
```