Skip to content

Commit 77c0ca3

Browse files
committed
update user guide
1 parent 1a0884b commit 77c0ca3

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

src/pages/user-guide.mdx

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,11 @@ basic-memory project add work ~/work-notes
180180
# List all projects
181181
basic-memory project list
182182
```
183+
<Warning>
184+
Moving notes from one project to another is not currently supported. The easiest
185+
thing to do is to either move the note yourself or write a new note, then delete
186+
the old note.
187+
</Warning>
183188

184189
### Enhanced Editing
185190

@@ -216,18 +221,6 @@ Tags are searchable: `"Find my brewing notes"` will find this document.
216221

217222
Basic Memory automatically syncs file changes in real-time. No manual sync needed.
218223

219-
### Manual Sync
220-
221-
If you prefer manual control:
222-
223-
```bash
224-
# Sync once
225-
basic-memory sync
226-
227-
# Disable auto-sync and sync manually
228-
basic-memory sync --no-watch
229-
```
230-
231224
### Checking Status
232225

233226
```bash
@@ -273,8 +266,8 @@ Basic Memory uses standard Markdown files that work with:
273266

274267
**Changes not syncing:**
275268
- Check `basic-memory status` for sync status
276-
- Restart sync with `basic-memory sync --watch`
277269
- Verify file permissions
270+
- Reset the database with `basic-memory reset`
278271

279272
**Claude can't find knowledge:**
280273
- Confirm files are in the correct project directory
@@ -287,6 +280,9 @@ Basic Memory uses standard Markdown files that work with:
287280
- Consider archiving old content
288281

289282
### Getting Help
283+
Live help is available on our [Discord server](https://discord.gg/tyvKNccgqN) in
284+
the #help channel. You can also find past conversations of people who may have
285+
encountered a problem similar to yours.
290286

291287
```bash
292288
# View all available commands
@@ -297,31 +293,33 @@ basic-memory sync --help
297293
basic-memory project --help
298294
```
299295

296+
300297
## Best Practices
301298

302299
### Knowledge Creation
303300

301+
1. **Create Relations** - Link related concepts
302+
1. **Make Observations** - Structure facts with semantic categories
303+
1. **Create an AI Assistant Guide** - AI assistants can be guided through a reference note
304304
1. **Be descriptive** - Use clear titles and rich content
305-
2. **Add context** - Include background and reasoning
306-
3. **Create connections** - Link related concepts
307-
4. **Use categories** - Structure observations semantically
308-
5. **Review and refine** - Edit AI-generated content for accuracy
305+
1. **Add context** - Include background and reasoning
306+
1. **Use categories** - Structure observations semantically
307+
1. **Review and refine** - Edit AI-generated content for accuracy
309308

310309
### Workflow
311310

312-
1. **Start conversations contextually** - Use special prompts
313-
2. **Build incrementally** - Add to existing notes rather than creating duplicates
314-
3. **Organize regularly** - Move old content to appropriate folders
315-
4. **Cross-reference** - Link new content to existing knowledge
316-
5. **Switch projects** - Use different projects for different contexts
311+
1. **Use Special Prompts** - Start conversations contextually
312+
1. **Build incrementally** - Add to existing notes rather than creating duplicates
313+
1. **Organize regularly** - Move old content to appropriate folders
314+
1. **Cross-reference** - Link new content to existing knowledge
315+
1. **Switch projects** - Use different projects for different contexts and to create boundaries
317316

318317
### Long-term Maintenance
319318

320319
1. **Archive old content** - Keep active knowledge base focused
321320
2. **Refactor connections** - Update relations as knowledge evolves
322321
3. **Regular reviews** - Periodically review and update key documents
323322
4. **Backup regularly** - Use git or other backup solutions
324-
5. **Share appropriately** - Use git for collaboration when needed
325323

326324
## Next Steps
327325

0 commit comments

Comments
 (0)