Skip to content

Commit 24ef8f8

Browse files
committed
docs: comprehensive documentation update and QA verification
- Add complete user-facing documentation suite (USER_GUIDE, FEATURES, ARCHITECTURE, PROVIDERS, TOOLS, MEMORY, SECURITY, PERFORMANCE, INSTALLATION) - Add SECURITY.md vulnerability reporting policy - Update README.md with new docs structure and provider list (add Google Gemini, MiniMax, OpenRouter) - Update AGENTS.md with accurate Xcode version (16.0+) and corrected tool/provider counts - Update project-docs with latest specifications - Add llms.txt to gitignore exception - Full QA pass verifying all documentation against current source code
1 parent c637155 commit 24ef8f8

19 files changed

Lines changed: 3062 additions & 23 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ nohup.out
2222
.last_version
2323
*.log
2424
/*.txt
25+
!llms.txt
2526
/*.json
2627

2728
# Test output

AGENTS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ SAM (Synthetic Autonomic Mind) is a native macOS AI assistant built with Swift a
1919
### Prerequisites
2020

2121
- macOS 14.0+ (development on macOS 15.0+)
22-
- Xcode 14.0+ with Swift 6.0+
22+
- Xcode 16.0+ with Swift 6.0+
2323
- Command line tools: `xcode-select --install`
2424
- ccache (optional, speeds up builds): `brew install ccache`
2525

@@ -202,18 +202,20 @@ Sources/
202202
│ └── PropertiesStorage/
203203
├── APIFramework/ - Multi-provider support, orchestration
204204
│ ├── APIProvider.swift (protocol)
205-
│ ├── Providers/ (OpenAI, Anthropic, DeepSeek, GitHub Copilot)
205+
│ ├── Providers/ (OpenAI, Anthropic, GitHub Copilot, Google Gemini, DeepSeek, MiniMax, OpenRouter)
206206
│ ├── AgentOrchestrator.swift (multi-step workflows)
207207
│ └── ToolCallExtractor.swift
208208
├── MCPFramework/ - Model Context Protocol tools
209209
│ ├── MCPTool.swift (protocol)
210-
│ ├── Tools/ (10 tools, 60+ operations)
210+
│ ├── Tools/ (8 tools, 60+ operations)
211211
│ ├── ToolRegistry.swift
212212
│ └── ToolResult.swift
213213
├── SharedData/ - Shared types, thread-safe storage
214214
│ ├── SharedTopics.swift
215215
│ ├── Storage.swift
216216
│ └── Locking/
217+
├── SecurityFramework/ - Authorization, path security
218+
│ └── SecurityOperations.swift
217219
└── VoiceFramework/ - Speech recognition, TTS, wake word
218220
├── SpeechRecognizer.swift
219221
├── TextToSpeech.swift

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ SAM is a native macOS AI assistant built with Swift and SwiftUI. Unlike cloud-on
1818

1919
- **Website:** [www.syntheticautonomicmind.org](https://www.syntheticautonomicmind.org)
2020
- **Download SAM:** [Latest Release](https://github.com/SyntheticAutonomicMind/SAM/releases)
21-
- **Documentation:** [User Guides & Tutorials](https://www.syntheticautonomicmind.org)
21+
- **Documentation:** [User Guide](docs/USER_GUIDE.md) · [Features](docs/FEATURES.md) · [All Docs](docs/)
2222
- **Source Code:** [GitHub Repository](https://github.com/SyntheticAutonomicMind/SAM)
2323
- **Report Issues:** [Issue Tracker](https://github.com/SyntheticAutonomicMind/SAM/issues)
24+
- **Security:** [Security Policy](SECURITY.md)
2425
- **Support SAM:** [Patreon](https://www.patreon.com/fewtarius)
2526

2627
---
@@ -118,7 +119,7 @@ SAM's clean interface and natural interactions make powerful AI accessible to ev
118119

119120
## Features at a Glance
120121

121-
- **MultiAI support**: Choose from OpenAI, Anthropic (Claude), GitHub Copilot, DeepSeek, or run models locally (MLX, llama.cpp)
122+
- **Multi-AI support**: Choose from OpenAI, Anthropic (Claude), GitHub Copilot, Google Gemini, DeepSeek, MiniMax, or run models locally (MLX, llama.cpp)
122123
- **Voice in & out**: "Hey SAM" wake word, speech recognition, and natural text‑to‑speech
123124
- **Image generation**: Create images via [ALICE](https://github.com/SyntheticAutonomicMind/ALICE) server with automatic model discovery
124125
- **Math tools**: Real computation for calculations, conversions, and financial formulas
@@ -146,7 +147,7 @@ Get a glimpse of SAM's native macOS interface in action:
146147
<td width="50%">
147148
<h3>Flexible AI Provider Selection</h3>
148149
<img src=".images/sam-image-2.png"/>
149-
<em>Choose from local models (MLX, llama.cpp), or cloud providers (OpenAI, Anthropic, DeepSeek, OpenRouter)</em>
150+
<em>Choose from local models (MLX, llama.cpp), or cloud providers (OpenAI, Anthropic, Google Gemini, DeepSeek, MiniMax, OpenRouter)</em>
150151
</td>
151152
</tr>
152153
</table>
@@ -217,7 +218,7 @@ Get a glimpse of SAM's native macOS interface in action:
217218
- Secure API authentication
218219

219220
**Flexible AI Provider Support**
220-
- **Cloud AI**: OpenAI, Anthropic (Claude), GitHub Copilot, DeepSeek, OpenRouter
221+
- **Cloud AI**: OpenAI, Anthropic (Claude), GitHub Copilot, Google Gemini, DeepSeek, MiniMax, OpenRouter
221222
- **Local Models**: Run AI completely on your Mac with MLX or llama.cpp
222223
- Switch models mid-conversation
223224
- Use custom OpenAI-compatible endpoints
@@ -254,7 +255,7 @@ brew upgrade --cask sam
254255
3. Go to **AI Providers** tab
255256
4. Click **Add Provider**
256257
5. Choose your provider:
257-
- **Cloud AI**: OpenAI, Claude, GitHub Copilot, or DeepSeek
258+
- **Cloud AI**: OpenAI, Claude, GitHub Copilot, Google Gemini, DeepSeek, MiniMax, or OpenRouter
258259
- **Local Model**: Choose a model to download and run on your Mac
259260
6. For cloud providers: Enter your API key
260261
7. Save and start chatting!
@@ -358,6 +359,9 @@ Your feedback helps make SAM better for everyone!
358359
| **Anthropic** | Claude 3.5 Sonnet, Claude 4 (long context) |
359360
| **GitHub Copilot** | GPT-4o, Claude 3.5, o1 (requires subscription) |
360361
| **DeepSeek** | Cost-effective AI models |
362+
| **Google Gemini** | Gemini 2.5 Pro/Flash, large context windows |
363+
| **MiniMax** | MiniMax-M2.7, M2.5 (128K context) |
364+
| **OpenRouter** | Access 100+ models from multiple providers |
361365
| **Local MLX** | Run models on Apple Silicon Macs |
362366
| **Local llama.cpp** | Run models on any Mac (Intel or Apple Silicon) |
363367
| **Custom** | Use any OpenAI-compatible API |
@@ -478,9 +482,8 @@ When you use cloud AI providers (OpenAI, Claude, etc.), only the messages you se
478482

479483
### Downloaded AI Models
480484
```
481-
~/Library/Caches/sam/models/
482-
├── mlx/ # MLX models (Apple Silicon)
483-
└── gguf/ # llama.cpp models
485+
~/Library/Caches/sam-rewritten/models/
486+
└── {model-name}/ # Individual model files
484487
```
485488

486489
### Working Files
@@ -582,10 +585,19 @@ For developers who want to build SAM from source, see [BUILDING.md](BUILDING.md)
582585

583586
Complete documentation is available:
584587

585-
- **[Website](https://www.syntheticautonomicmind.org)** - User guides and tutorials
586-
- **[project-docs/](project-docs/)** - Technical documentation for developers
587-
- **[BUILDING.md](BUILDING.md)** - Build instructions
588+
- **[User Guide](docs/USER_GUIDE.md)** - Getting started and using SAM
589+
- **[Features](docs/FEATURES.md)** - Complete feature reference
590+
- **[Architecture](docs/ARCHITECTURE.md)** - How SAM is built
591+
- **[Providers](docs/PROVIDERS.md)** - AI provider setup guide
592+
- **[Tools](docs/TOOLS.md)** - Built-in tools reference
593+
- **[Memory](docs/MEMORY.md)** - Memory and search system
594+
- **[Security](docs/SECURITY.md)** - Privacy and security model
595+
- **[Installation](docs/INSTALLATION.md)** - Installation guide
596+
- **[Performance](docs/PERFORMANCE.md)** - Performance and optimization
597+
- **[BUILDING.md](BUILDING.md)** - Build from source
588598
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - How to contribute
599+
- **[project-docs/](project-docs/)** - Internal technical specifications
600+
- **[Website](https://www.syntheticautonomicmind.org)** - Online guides
589601

590602
---
591603

SECURITY.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you discover a security vulnerability in SAM, please report it responsibly:
6+
7+
1. **Do not** open a public GitHub issue
8+
2. Email the maintainer directly at the security contact listed on the [GitHub repository](https://github.com/SyntheticAutonomicMind/SAM)
9+
3. Include a detailed description of the vulnerability
10+
4. Include steps to reproduce the issue
11+
5. Allow reasonable time for a fix before public disclosure
12+
13+
## Response Timeline
14+
15+
- **Acknowledgment:** Within 48 hours
16+
- **Initial assessment:** Within 1 week
17+
- **Fix for critical issues:** As soon as possible, targeting same-week release
18+
- **Fix for non-critical issues:** Included in the next scheduled release
19+
20+
## Supported Versions
21+
22+
Only the latest release is supported with security updates. We recommend always running the most recent version.
23+
24+
| Version | Supported |
25+
|---------|-----------|
26+
| Latest release | Yes |
27+
| Previous releases | No |
28+
| Development builds | Best effort |
29+
30+
## Scope
31+
32+
The following are in scope for security reports:
33+
34+
- Authentication bypass in the API server
35+
- Unauthorized file access through the tool system
36+
- API key exposure or insecure storage
37+
- Remote code execution vulnerabilities
38+
- Privilege escalation
39+
40+
The following are out of scope:
41+
42+
- Issues requiring physical access to the Mac
43+
- Social engineering attacks
44+
- Vulnerabilities in third-party AI providers (report to the provider directly)
45+
- Issues in development/debug builds only
46+
47+
## Security Model
48+
49+
For details about SAM's security design, see [docs/SECURITY.md](docs/SECURITY.md).

0 commit comments

Comments
 (0)