Skip to content

Commit 6006a94

Browse files
phernandezclaude
andcommitted
docs: add What's New highlights, integration pages, and site fixes
- Add What's New highlight pages for Agent Skills, OpenClaw Plugin, and AI-Friendly Docs - Add full integration pages for Agent Skills and OpenClaw Plugin - Add cloud routing documentation page - Add X/Twitter social link to footer and community nav - Fix broken /cloud/cloud-app/notes-interface links → /cloud/web-app - Remove stale TODO screenshot comments - Update docs content for v0.19.0 (search, schemas, semantic search, CLI reference) - Replace robots.txt with _robots.txt for Nuxt/Nitro handling Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 679a4dc commit 6006a94

35 files changed

+1385
-382
lines changed

CLAUDE.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This is the documentation website for Basic Memory (`docs.basicmemory.com`), bui
1212

1313
**Repository**: https://github.com/basicmachines-co/basic-memory
1414
**Website**: https://basicmemory.com
15-
**Current Version**: v0.18.0 (released January 28, 2026)
15+
**Current Version**: v0.19.0 (released March 2026)
1616

1717
**Key Features**:
1818
- 17 MCP tools for AI integration (write_note, read_note, edit_note, search_notes, build_context, etc.)
@@ -23,11 +23,14 @@ This is the documentation website for Basic Memory (`docs.basicmemory.com`), bui
2323
- Real-time file synchronization
2424
- SQLite and PostgreSQL database backends
2525

26-
**v0.18.0 Major Features**:
27-
- Context-aware wiki link resolution with source_path support
28-
- Directory support for move_note and delete_note tools
29-
- Local MCP cloud mode routing for simultaneous local/cloud usage
30-
- Cloud snapshot CLI commands for backup management
26+
**v0.19.0 Major Features**:
27+
- Schema system for note structure validation
28+
- Semantic vector search with hybrid fusion
29+
- Per-project cloud routing
30+
- Project-prefixed permalinks
31+
- `write_note` overwrite guard
32+
- JSON output mode for all MCP tools
33+
- Unified metadata search (search_by_metadata merged into search_notes)
3134

3235
### Basic Memory Cloud
3336

@@ -59,7 +62,7 @@ This documentation site covers both:
5962
1. **Basic Memory** (local-first product) - Installation, MCP tools, CLI, integrations, knowledge format
6063
2. **Basic Memory Cloud** (upcoming) - Cloud-specific features, authentication, sync, billing
6164

62-
The site documents the latest v0.17.x release and includes cloud product documentation.
65+
The site documents the latest v0.19.x release and includes cloud product documentation.
6366

6467
## Development Commands
6568

@@ -169,13 +172,13 @@ pip install basic-memory
169172

170173
## Documentation Status & Priorities
171174

172-
Documentation is up-to-date for v0.17.x release. Cloud product documentation is complete.
175+
Documentation is up-to-date for v0.19.x release. Cloud product documentation is complete.
173176

174177
### Reference Materials
175178

176179
When documenting features:
177180
- **Basic Memory CHANGELOG**: `gh api repos/basicmachines-co/basic-memory/contents/CHANGELOG.md`
178-
- **Release Notes**: `gh release view v0.17.2 --repo basicmachines-co/basic-memory`
181+
- **Release Notes**: `gh release view v0.19.0 --repo basicmachines-co/basic-memory`
179182
- **Basic Memory README**: https://github.com/basicmachines-co/basic-memory
180183
- **Cloud README**: https://github.com/basicmachines-co/basic-memory-cloud
181184
- **Cloud CLAUDE.md**: https://github.com/basicmachines-co/basic-memory-cloud/blob/main/CLAUDE.md

app/app.config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export default defineAppConfig({
4444
},
4545
socials: {
4646
github: 'https://github.com/basicmachines-co/basic-memory',
47+
x: 'https://x.com/basic_memory',
4748
discord: 'https://discord.gg/tyvKNccgqN',
4849
reddit: 'https://www.reddit.com/r/basicmemory',
4950
},
@@ -52,6 +53,7 @@ export default defineAppConfig({
5253
title: 'Community',
5354
links: [
5455
{ label: 'GitHub', to: 'https://github.com/basicmachines-co/basic-memory' },
56+
{ label: 'X / Twitter', to: 'https://x.com/basic_memory' },
5557
{ label: 'Discord', to: 'https://discord.gg/tyvKNccgqN' },
5658
{ label: 'Reddit', to: 'https://www.reddit.com/r/basicmemory' },
5759
],

content/1.start-here/2.quickstart-cloud.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ code: |
2121

2222
Sign up at [app.basicmemory.com](https://app.basicmemory.com). You'll need an active subscription to use the MCP endpoint.
2323

24-
<!-- TODO: Screenshot - Cloud signup page -->
2524
![Cloud signup page](/screenshots/cloud/signup.png)
2625

2726
---

content/1.start-here/3.quickstart-local.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ code: |
1919

2020
## 1. Install Basic Memory
2121

22-
Choose your installation method. The default install includes semantic search dependencies for hybrid (keyword + meaning-based) search.
22+
Choose your installation method. All installs include semantic search for hybrid (keyword + meaning-based) search.
2323

2424
### macOS (Homebrew) - Recommended
2525

@@ -28,30 +28,18 @@ brew tap basicmachines-co/basic-memory
2828
brew install basic-memory
2929
```
3030

31-
Homebrew includes semantic search dependencies automatically.
32-
3331
### All platforms (uv)
3432

3533
First install `uv` from [astral.sh](https://docs.astral.sh/uv/getting-started/installation/), then:
3634

3735
```bash
38-
uv tool install 'basic-memory[semantic]'
36+
uv tool install basic-memory
3937
```
4038

4139
::note
4240
**Requirements:** Python 3.13 or higher. Check with `python --version`.
4341
::
4442

45-
### Lightweight install (without semantic search)
46-
47-
If you don't need hybrid search or want a smaller install:
48-
49-
```bash
50-
uv tool install basic-memory
51-
```
52-
53-
Search will use keyword-only mode. You can add semantic search later with `uv tool upgrade 'basic-memory[semantic]'`.
54-
5543
### Verify installation
5644

5745
```bash
@@ -60,7 +48,7 @@ basic-memory --version
6048

6149
**Expected output:**
6250
```bash
63-
basic-memory, version 0.18.x
51+
basic-memory, version 0.19.x
6452
```
6553

6654
---
@@ -94,16 +82,12 @@ Add this configuration:
9482

9583
**Restart Claude Desktop** after editing the config.
9684

97-
<!-- TODO: Screenshot - Config file in editor -->
98-
![Claude Desktop config file](/screenshots/claude/config-file.png)
99-
10085
---
10186

10287
## 3. Verify the connection
10388

10489
In Claude Desktop, click the **tools icon** (hammer) in the bottom-right of the chat interface. You should see Basic Memory tools listed.
10590

106-
<!-- TODO: Screenshot - Claude tools menu showing Basic Memory -->
10791
![Claude - Tools menu with Basic Memory](/screenshots/claude/tools-menu-local.png)
10892

10993
Ask Claude:
@@ -118,8 +102,7 @@ You have 1 project:
118102
- main (default) - ~/basic-memory - 0 notes
119103
```
120104

121-
<!-- TODO: Screenshot - Claude project list response -->
122-
![Claude - Project list](/screenshots/claude/project-list-local.png)
105+
![Claude - Project list](/screenshots/claude/project-list-response.png)
123106

124107
---
125108

@@ -148,8 +131,7 @@ It includes an overview of Basic Memory's key features:
148131
- Search across your knowledge base
149132
```
150133
151-
<!-- TODO: Screenshot - Claude creating a note locally -->
152-
![Claude - Creating first note](/screenshots/claude/create-note-local.png)
134+
![Claude - Creating first note](/screenshots/claude/create-first-note.png)
153135
154136
---
155137
@@ -174,9 +156,6 @@ explorer ~/basic-memory # Windows
174156
2. **Create new vault** → select `~/basic-memory`
175157
3. Use the **graph view** to see connections between notes
176158
177-
<!-- TODO: Screenshot - Obsidian with Basic Memory vault and graph view -->
178-
![Obsidian - Basic Memory vault with graph](/screenshots/obsidian/vault-with-graph.png)
179-
180159
### Example note structure
181160
182161
After creating a few notes, your folder might look like:
@@ -278,9 +257,6 @@ basic-memory import chatgpt
278257
basic-memory sync
279258
```
280259
281-
<!-- TODO: GIF - CLI commands in action -->
282-
![CLI commands demo](/screenshots/cli/commands-demo.gif)
283-
284260
---
285261
286262
## Troubleshooting

content/2.whats-new/0.v0.19.0.md

Lines changed: 53 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Basic Memory now includes semantic search by default — hybrid search combines
6060

6161
Three search modes are available:
6262

63-
- **`hybrid`** (default) — Combines keyword and semantic search with score-based fusion
63+
- **`hybrid`** (default) — Combines keyword and semantic search
6464
- **`text`** — Keyword-only search
6565
- **`vector`** — Pure semantic similarity search
6666

@@ -83,6 +83,31 @@ See the full [Semantic Search](/concepts/semantic-search) guide for configuratio
8383

8484
---
8585

86+
## Metadata Search
87+
88+
`search_notes` now supports searching by frontmatter metadata. The `query` parameter is optional, so you can search purely by metadata fields.
89+
90+
```python
91+
search_notes(metadata_filters={"status": "in-progress"})
92+
search_notes(metadata_filters={"tags": ["security", "oauth"]})
93+
search_notes(metadata_filters={"priority": {"$in": ["high", "critical"]}})
94+
search_notes(tags=["security"]) # convenience shorthand
95+
search_notes(status="draft") # convenience shorthand
96+
```
97+
98+
---
99+
100+
## `tag:` Search Shorthand
101+
102+
Search by tag using convenient shorthand syntax instead of structured filters:
103+
104+
```python
105+
search_notes("tag:security")
106+
search_notes("tag:coffee AND tag:brewing")
107+
```
108+
109+
---
110+
86111
## Per-Project Local/Cloud Routing
87112

88113
You can now route individual projects through cloud while keeping others local. The stdio MCP server only calls local projects, while cloud projects are available via CLI commands.
@@ -104,6 +129,8 @@ The routing model has three levels:
104129
2. **Per-project**`bm project set-cloud/set-local` overrides for specific projects
105130
3. **Per-command**`--local` / `--cloud` flags provide one-off overrides
106131

132+
See [Local & Cloud Routing](/cloud/routing) for the full guide, including hybrid setups and common configurations.
133+
107134
---
108135

109136
## Project-Prefixed Permalinks
@@ -119,31 +146,6 @@ This makes cross-project references unambiguous. Within notes, the `project::not
119146

120147
---
121148

122-
## Unified Metadata Search
123-
124-
`search_by_metadata` has been merged into `search_notes` — one tool for all searches. The `query` parameter is now optional, so you can search purely by frontmatter metadata.
125-
126-
```python
127-
search_notes(metadata_filters={"status": "in-progress"})
128-
search_notes(metadata_filters={"tags": ["security", "oauth"]})
129-
search_notes(metadata_filters={"priority": {"$in": ["high", "critical"]}})
130-
search_notes(tags=["security"]) # convenience shorthand
131-
search_notes(status="draft") # convenience shorthand
132-
```
133-
134-
---
135-
136-
## `tag:` Search Shorthand
137-
138-
Search by tag using convenient shorthand syntax instead of structured filters:
139-
140-
```python
141-
search_notes("tag:security")
142-
search_notes("tag:coffee AND tag:brewing")
143-
```
144-
145-
---
146-
147149
## `write_note` Overwrite Guard
148150

149151
`write_note` is now non-idempotent by default. If a note already exists at the target path, the tool returns an error instead of silently overwriting. This prevents accidental data loss.
@@ -187,18 +189,6 @@ The `note_type` sets the `type` frontmatter field (used for schema resolution an
187189

188190
---
189191

190-
## Score-Based Hybrid Fusion
191-
192-
The hybrid search scoring algorithm has been replaced. The old Reciprocal Rank Fusion (RRF) compressed all fused scores to ~0.016, destroying ranking differentiation. The new formula preserves dominant signals and rewards dual-source agreement:
193-
194-
```
195-
score = max(vec, fts) + 0.3 * min(vec, fts)
196-
```
197-
198-
Zero-score results now produce zero fused score instead of receiving a weight floor. Search result ordering may differ from v0.18 — results should be more accurate with better score differentiation.
199-
200-
---
201-
202192
## Dashboard (`bm project info`)
203193

204194
`bm project info` now displays an htop-inspired compact dashboard with:
@@ -207,21 +197,37 @@ Zero-score results now produce zero fused score instead of receiving a weight fl
207197
- Embedding coverage bar with Unicode block characters
208198
- Colored status dots for at-a-glance health
209199

200+
```
201+
╭────────────────────────────────────── specs ──────────────────────────────────────╮
202+
│ Knowledge Graph Embeddings │
203+
│ Entities 110 ● Semantic Search Enabled │
204+
│ Observations 585 Provider fastembed │
205+
│ Relations 319 Model bge-small-en-v1.5 │
206+
│ Unresolved 131 Indexed │
207+
│ Isolated 27 █████░░░░░░░░░░░░░░░ │
208+
│ 26/110 │
209+
│ Chunks 4085 │
210+
│ ● Status Reindex recommended │
211+
│ Reason 260 orphaned chunks found │
212+
│ (interrupted indexing) — run: │
213+
│ bm reindex --embeddings │
214+
│ │
215+
│ Note Types │
216+
│ note ████████████████████████████████████████ 72 │
217+
│ spec ███████████████████░░░░░░░░░░░░░░░░░░░░░ 35 │
218+
│ file █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 2 │
219+
│ tasklist █░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 1 │
220+
│ │
221+
│ │
222+
│ /specs default: main 2026-03-02 05:14 │
223+
╰─────────────────────────────── Basic Memory 0.00.0 ───────────────────────────────╯
224+
```
210225
---
211226

212227
## Entity User Tracking
213228

214229
Entities now track `created_by` and `last_updated_by` fields for attribution, so you can see whether a note was created by a human or an AI assistant.
215230

216-
---
217-
218-
## Improved Search Results
219-
220-
Search results now surface more relevant context:
221-
222-
- `matched_chunk_text` populated for FTS-only hybrid results (no more fallback to truncated content)
223-
- Top chunks per result increased from 3 to 5, catching answers deeper in large notes
224-
- Content display limit doubled from 2,000 to 4,000 characters for results without matched chunks
225231

226232
---
227233

@@ -310,24 +316,6 @@ Existing permalinks without a project prefix still resolve correctly — resolut
310316

311317
**Get text output:** Pass `output_format="text"` explicitly.
312318

313-
### Hybrid search scoring algorithm
314-
315-
The hybrid search scoring formula changed from Reciprocal Rank Fusion (RRF) to score-based fusion. The old RRF formula compressed all fused scores to ~0.016, destroying ranking differentiation. The new formula preserves dominant signals and rewards dual-source agreement.
316-
317-
Search result ordering may differ from v0.18. Results should be more accurate with better score differentiation. Zero-score results now produce zero fused score instead of receiving a weight floor.
318-
319-
### `search_by_metadata` removed
320-
321-
`search_by_metadata` is no longer a standalone tool. Use `search_notes` with `metadata_filters` instead — same parameters, same behavior.
322-
323-
```python
324-
# Before (v0.18)
325-
search_by_metadata(metadata_filters={"status": "draft"})
326-
327-
# After (v0.19)
328-
search_notes(metadata_filters={"status": "draft"})
329-
```
330-
331319
### `default_project_mode` removed
332320

333321
The `default_project_mode` setting is no longer used. Use `default_project` as the fallback when no project is explicitly passed to a tool or command. Per-project routing (`set-cloud` / `set-local`) replaces the global mode toggle.

content/2.whats-new/1.cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Get started with Basic Memory Cloud.
161161
---
162162
title: Notes Interface
163163
icon: i-lucide-layout-panel-left
164-
to: /cloud/cloud-app/notes-interface
164+
to: /cloud/web-app
165165
---
166166
Learn about the Cloud notes UI.
167167
::

0 commit comments

Comments
 (0)