Skip to content

Commit deb49b8

Browse files
committed
docs: polish content accuracy and update README integrations
1 parent 7a584f7 commit deb49b8

File tree

3 files changed

+34
-35
lines changed

3 files changed

+34
-35
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The Native App relies on **Tauri v2**, which compiles a high-performance binary
7171
| **Visualization** | Lucide Icons, Recharts, Custom Graph Renderer |
7272
| **Math Engine** | Custom Hypergraph (TypeScript) |
7373
| **Desktop** | Tauri 2.0 + Rust (Native ARM64/x64) |
74-
| **AI Integration** | Google Gemini, Groq (Llama 3), Ollama (Local) |
74+
| **AI Integration** | Google Gemini, Groq, Ollama (Local) |
7575

7676
---
7777

@@ -247,7 +247,7 @@ Not about making AI more capable—about making it **safer as it becomes more ca
247247
**Support This Work**
248248
If SCE helps your research or project, consider supporting its development:
249249

250-
[💝 Sponsor via GitHub](https://github.com/sponsors/sasus-dev)[☕ Buy me a coffee](https://buymeacoffee.com/sasus)[🌟 Star the repo](https://github.com/sasus-dev/synapse-context-engine)
250+
[💝 Sponsor via GitHub](https://github.com/sponsors/sasus-dev)[🌟 Star the repo](https://github.com/sasus-dev/synapse-context-engine)
251251

252252
---
253253

docs/guides/API-Reference.md

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -30,22 +30,23 @@ The primary data structure representing the entire memory graph.
3030
interface Node {
3131
id: string;
3232
label: string;
33-
type: 'project' | 'contact' | 'artifact' | 'preference' | 'behavior' | 'goal';
33+
type: 'project' | 'document' | 'contact' | 'preference' | 'behavior' | 'goal' | 'concept' | 'tool' | 'fact';
3434
metadata?: Record<string, any>;
3535
heat?: number; // Temporal relevance (0-1)
3636
lastAccessed?: number; // Unix timestamp
3737
activationThreshold?: number; // Minimum energy to fire (default: 0.3)
3838
isArchived?: boolean; // Excluded from active retrieval
39+
embedding?: number[]; // Vector representation
3940
}
4041
```
4142

4243
**Node Types:**
4344
- `project` - Tasks, initiatives, workstreams
44-
- `contact` - People, organizations, relationships
45-
- `artifact` - Documents, files, created content
46-
- `preference` - User settings, style choices
47-
- `behavior` - Learned patterns, habits
48-
- `goal` - Persistent objectives (always seed nodes)
45+
- `document` - Files, artifacts, content
46+
- `contact` - People, organizations
47+
- `concept` - Abstract ideas, topics
48+
- `goal` - Persistent objectives
49+
- `tool` - Executable capabilities
4950

5051
### `Edge`
5152
```typescript
@@ -77,41 +78,39 @@ interface ActivatedNode {
7778
### `EngineConfig`
7879
```typescript
7980
interface EngineConfig {
80-
// Spreading Activation
81-
activationTheta: number; // Threshold (0-1, default: 0.30)
82-
decayGamma: number; // Decay rate (0-1, default: 0.85)
83-
maxDepth: number; // Traversal depth (1-5, default: 3)
81+
// Physics Parameters
82+
gamma: number; // Decay rate (0-1, default: 0.85)
83+
theta: number; // Activation threshold (0-1, default: 0.30)
84+
heatBias: number; // Recency weight (0-1, default: 0.40)
85+
mmrLambda: number; // Diversity penalty (0-1, default: 0.70)
86+
maxActivationDepth: number; // Traversal hops (1-5, default: 3)
8487

85-
// Temporal Bias
86-
heatAlpha: number; // Recency weight (0-1, default: 0.40)
88+
// Features
89+
enableHebbian: boolean; // Enable synaptic plasticity
90+
enablePruning: boolean; // Enable MMR pruning
91+
enableSpreadingActivation: boolean;
92+
safeMode: boolean; // Enforce strict checks
8793

88-
// Context Selection (MMR)
89-
mmrLambda: number; // Relevance vs diversity (0-1, default: 0.70)
90-
maxContextNodes: number; // Top-K selection (5-30, default: 15)
91-
92-
// Hebbian Learning
93-
learningRate: number; // η in Δw = η(E_i × E_j - w), default: 0.05
94-
95-
// Safety
96-
enableContradictionDetection: boolean; // Default: true
97-
enableArchiving: boolean; // Auto-archive stale nodes, default: true
98-
archiveThreshold: number; // Days of inactivity, default: 30
94+
// LLM Integration
95+
extractionProvider: 'gemini' | 'ollama' | 'groq' | 'rules-only';
96+
inferenceProvider: 'gemini' | 'ollama' | 'groq';
9997
}
10098
```
10199

102100
### Default Configuration
103101
```typescript
104102
const DEFAULT_CONFIG: EngineConfig = {
105-
activationTheta: 0.30,
106-
decayGamma: 0.85,
107-
maxDepth: 3,
108-
heatAlpha: 0.40,
103+
gamma: 0.85,
104+
theta: 0.30,
105+
heatBias: 0.40,
109106
mmrLambda: 0.70,
110-
maxContextNodes: 15,
111-
learningRate: 0.05,
112-
enableContradictionDetection: true,
113-
enableArchiving: true,
114-
archiveThreshold: 30
107+
maxActivationDepth: 3,
108+
enableHebbian: true,
109+
enablePruning: true,
110+
enableSpreadingActivation: true,
111+
safeMode: true,
112+
extractionProvider: 'groq',
113+
inferenceProvider: 'groq'
115114
};
116115
```
117116

docs/guides/Quick-Start-Tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Open `http://localhost:5173` in your browser.
3030

3131
### Main Components
3232

33-
**1. Activation Source** (Top Left)
33+
**1. Active Focus** (Top Left)
3434
- Select which project/node serves as your "active focus"
3535
- All spreading activation starts from here
3636
- Think of it as "what am I currently working on?"

0 commit comments

Comments
 (0)