Skip to content

Commit e086663

Browse files
committed
update docs for v0.15.0 project modes
Signed-off-by: phernandez <[email protected]>
1 parent 2eca823 commit e086663

File tree

4 files changed

+281
-403
lines changed

4 files changed

+281
-403
lines changed

package-lock.json

Lines changed: 0 additions & 251 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/pages/guides/ai-assistant-guide.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Card, CardGroup, Info, Warning, Note, Tip, Accordion, AccordionItem, St
1010
<Note>
1111
This is an optional document that can be copy/pasted into the project knowledge for an LLM to provide a full description of how it can work with Basic Memory. It is provided as a helpful resource. The tools contain extensive usage description prompts with enable the LLM to understand them.
1212

13-
You can [download](https://github.com/basicmachines-co/basic-memory/blob/main/docs/AI%20Assistant%20Guide.md) the contents of this file from GitHub
13+
You can [download](https://github.com/basicmachines-co/basic-memory/blob/main/src/basic_memory/mcp/resources/ai_assistant_guide.md) the contents of this file from GitHub
1414
</Note>
1515

1616
This guide helps you, the AI assistant, use Basic Memory tools effectively when working with users. It covers reading, writing, and navigating knowledge through the Model Context Protocol (MCP).
@@ -397,8 +397,8 @@ Discussed strategies for improving the chocolate chip cookie recipe.
397397
**User:** "My notes are getting messy in the main folder."
398398

399399
**Workflow:**
400-
1. `move_note("Old Meeting Notes", "archive/2024/old-meetings.md")`
401-
2. `move_note("Project Notes", "projects/client-work/notes.md")`
400+
1. `move_note("Old Meeting Notes", "archive/2024/old-meetings.md", project="work-notes")`
401+
2. `move_note("Project Notes", "projects/client-work/notes.md", project="work-notes")`
402402

403403
### Creating Effective Relations
404404

@@ -409,7 +409,7 @@ When creating relations:
409409
4. **Use meaningful relation types**: `implements`, `requires`, `part_of` vs generic `relates_to`
410410

411411
**Example workflow:**
412-
1. `search_notes("travel")` to find existing travel-related notes
412+
1. `search_notes("travel", project="personal")` to find existing travel-related notes
413413
2. Reference found entities: `- part_of [[Japan Travel Guide]]`
414414
3. Add forward references: `- located_in [[Tokyo]]` (even if Tokyo note doesn't exist yet)
415415

0 commit comments

Comments
 (0)