ORGANIZE: Move documentation to proper directories

- Moved API design docs to docs/api-design/
- Moved planning docs to docs/planning/
- Root now only contains standard repo files (README, LICENSE, etc.)
- Keeps CLAUDE.md and PLAN.md uncommitted for privacy

Clean root directory for better project organization.
This commit is contained in:
David Snelling 2025-08-25 09:53:41 -07:00
parent 26c7d61185
commit 2c4b34e9fb
19 changed files with 0 additions and 0 deletions

View file

@ -0,0 +1,62 @@
# 🧠 Brainy 2.0 Quick Reference Card
## Core Operations
```typescript
// Nouns
await brain.addNoun(vector, metadata) // Create
await brain.getNoun(id) // Read
await brain.updateNoun(id, vector?, meta?) // Update
await brain.deleteNoun(id) // Delete
// Verbs
await brain.addVerb(source, target, type) // Create relationship
await brain.getVerb(id) // Get relationship
await brain.deleteVerb(id) // Delete relationship
// Metadata
await brain.getNounMetadata(id) // Get metadata only
await brain.updateNounMetadata(id, meta) // Update metadata only
await brain.hasNoun(id) // Check existence
```
## Search
```typescript
await brain.search(query, k?) // Vector search
await brain.searchText('natural language') // NLP search
await brain.findSimilar(id, k?) // Similarity search
await brain.find(tripleQuery) // Triple Intelligence 🧠
```
## Graph
```typescript
await brain.getConnections(id) // All connections
await brain.getVerbsBySource(id) // Outgoing
await brain.getVerbsByTarget(id) // Incoming
await brain.getVerbsByType(type) // By type
```
## Management
```typescript
brain.getCacheStats() // Cache stats
brain.clearCache() // Clear cache
brain.size() // Total count
await brain.getStats() // All statistics
await brain.clear() // Clear all data
```
## Lifecycle
```typescript
const brain = new BrainyData() // Create
await brain.init() // Initialize
await brain.shutdown() // Cleanup
```
## Configuration
```typescript
new BrainyData({
storage: 'auto', // auto | memory | filesystem | s3
cache: true, // Enable caching
index: true, // Enable indexing
dimensions: 384 // Vector dimensions
})
```