Skip to content

Commit 3991446

Browse files
docs: website refresh, localized READMEs, CI quality gates (#49)
docs: website refresh, localized READMEs, CI quality gates
2 parents dc61933 + b727432 commit 3991446

29 files changed

+3031
-2460
lines changed

.github/workflows/quality-gates.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ jobs:
1818

1919
- name: Run Production Gate
2020
run: |
21-
bash scripts/quality/production_readiness_gates.sh ${{ matrix.mode }}
21+
bash Resources/scripts/quality/production_readiness_gates.sh ${{ matrix.mode }}

.github/workflows/release-waxmcp.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ jobs:
2020
include:
2121
- runs-on: macos-14
2222
platform: darwin-x64
23-
triple: ""
24-
source-build: false
23+
triple: x86_64-apple-macosx14.0
24+
source-build: true
2525
- runs-on: macos-14
2626
platform: darwin-arm64
2727
triple: arm64-apple-macosx14.0

.github/workflows/waxcore-linux.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ jobs:
1515
- name: Install Linux codec dependencies
1616
run: |
1717
sudo apt-get update
18-
sudo apt-get install -y liblz4-dev zlib1g-dev
18+
sudo apt-get install -y liblz4-dev zlib1g-dev libsqlite3-dev
1919
2020
- name: Build WaxCore target
21-
run: swift build --target WaxCore
21+
run: swift build --target WaxCore -Xswiftc -DGRDBCUSTOMSQLITE
2222

2323
- name: Run WaxCore tests
24-
run: swift test --filter WaxCoreTests
24+
run: swift test --filter WaxCoreTests -Xswiftc -DGRDBCUSTOMSQLITE

.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,22 @@ AGENTS.md
2323
*.o
2424
*.swiftdeps
2525
tasks/
26+
docs/
27+
task/
28+
output/
29+
.tmp/
30+
.linux-scratch/
31+
.gemini/
32+
.sisyphus/
33+
/memvid-main/
34+
/memvid/
35+
*.log
36+
.env
37+
.env.*
38+
.idea/
39+
.zed/
40+
Resources/website/node_modules/
41+
Resources/website/.docusaurus/
42+
Resources/website/build/
43+
*.xcresult
44+
docs/\ntasks/\nscripts/

.tmp/swift-home-release/.npm/_logs/2026-02-27T01_01_02_664Z-debug-0.log

Lines changed: 0 additions & 19 deletions
This file was deleted.

.tmp/swift-home-release/.npm/_update-notifier-last-checked

Whitespace-only changes.

AGENTS.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ A skill is a set of local instructions to follow that is stored in a `SKILL.md`
2929
- Safety and fallback: If a skill can't be applied cleanly (missing files, unclear instructions), state the issue, pick the next-best approach, and continue.
3030
</INSTRUCTIONS>
3131

32+
# Wax on macOS (MCP Quickstart)
33+
34+
On macOS, use the MCP server for Claude Code tool-calls (fast, long-lived).
35+
36+
## Install (macOS)
37+
38+
### MCP Server (Claude Code)
39+
40+
```bash
41+
npx -y waxmcp@latest mcp install --scope user
42+
```
43+
3244
# Wax Agent API Reference
3345

3446
This documentation is specifically for AI Agents (like you) to understand how to interact with the **Wax** memory engine using the `MemoryOrchestrator` interface.
@@ -138,4 +150,3 @@ public struct Item {
138150

139151
**Example System Instruction for Agents using Wax**:
140152
"You have access to a long-term memory tool called `Wax`. When answering, first check if relevant information exists in memory. If you find relevant context, incorporate it into your answer. If the user provides new important information, save it to memory."
141-

CLAUDE.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Wax (macOS) - Claude Code Memory
2+
3+
## Install
4+
5+
### MCP Server (Claude Code)
6+
7+
```bash
8+
npx -y waxmcp@latest mcp install --scope user
9+
```
10+
11+
## Rules
12+
13+
1. **Session start** — call `wax_session_start`, then `wax_handoff_latest` to resume prior context (use `session_id` for scoped calls)
14+
2. **Before answering** — call `wax_recall` (or `wax_search` if you need raw ranked hits)
15+
3. **When you learn something durable** — call `wax_remember` (batch writes, then `wax_flush` to persist)
16+
4. **When corrected** — store the correction via `wax_remember` (and retract structured facts via `wax_fact_retract` when applicable), then `wax_flush`
17+
5. **Session end** — call `wax_handoff` (`content`, optional `project`, `pending_tasks`), then `wax_flush`, then `wax_session_end`
18+
19+
## Tools
20+
21+
| Tool | When |
22+
|------|------|
23+
| `wax_session_start` | Start a new memory session; use returned `session_id` to scope reads/writes |
24+
| `wax_session_end` | End the active session |
25+
| `wax_remember` | Store durable info (preferences, decisions, facts, key notes) |
26+
| `wax_recall` | Build RAG context for a query (recommended default read path) |
27+
| `wax_search` | Direct search when you need raw ranked hits (hybrid/text modes) |
28+
| `wax_flush` | Persist pending writes so they’re searchable and safe on disk |
29+
| `wax_stats` | Quick health check (store stats, embedder identity, vector search enabled) |
30+
| `wax_handoff` | End-of-session summary (`content`) + optional `pending_tasks` for continuity |
31+
| `wax_handoff_latest` | Start-of-session: load the most recent handoff (optionally by `project`) |
32+
| `wax_entity_upsert` | Create/update a structured entity (knowledge graph) |
33+
| `wax_entity_resolve` | Resolve entities by alias |
34+
| `wax_fact_assert` | Assert a structured fact |
35+
| `wax_fact_retract` | Retract (soft-delete) a structured fact by id |
36+
| `wax_facts_query` | Query structured facts |

0 commit comments

Comments
 (0)