docs: Major documentation cleanup and accuracy fixes for 1.0

 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

View file

@ -40,12 +40,12 @@ brainy init
# ✓ Performance tier (small, medium, large, enterprise)
```
## 🧠 The 7 Core Data Commands
## 🧠 The Core Commands
### 1. `brainy add` - Smart Data Addition
```bash
# Smart mode (auto-detects and processes)
brainy add "Elon Musk founded SpaceX in 2002"
brainy add "Satya Nadella became CEO of Microsoft in 2014"
# With metadata
brainy add "Customer feedback" --metadata '{"rating": 5, "source": "survey"}'
@ -60,7 +60,7 @@ brainy add "Raw text data" --literal
### 2. `brainy search` - Unified Search
```bash
# Semantic search
brainy search "companies founded by Elon"
brainy search "tech companies and their leaders"
# With filters
brainy search "customer feedback" --filter '{"rating": {"$gte": 4}}'
@ -111,30 +111,16 @@ brainy delete abc123 --hard
brainy delete --query "outdated content" --confirm
```
### 6. `brainy add-noun` - Create Typed Entities
### 6. `brainy export` - Export Your Data
```bash
# Create person entity
brainy add-noun "Sarah Thompson" --type Person
# Export to JSON
brainy export --format json --output backup.json
# With rich metadata
brainy add-noun "Project Apollo" --type Project --metadata '{
"status": "active",
"budget": "$500K",
"team_size": 12
}'
```
# Export with filters
brainy export --format csv --filter '{"type": "person"}' --output people.csv
### 7. `brainy add-verb` - Create Relationships
```bash
# Create relationship between entities
brainy add-verb person_sarah_123 project_apollo_456 --type WorksWith
# With relationship metadata
brainy add-verb person_sarah_123 project_apollo_456 --type WorksWith --metadata '{
"role": "Lead Designer",
"allocation": "75%",
"start_date": "2024-01-15"
}'
# Export with relationships
brainy export --include-relationships --output full-backup.json
```
## 🎮 Interactive Commands