From a507306d932ef20c78a87df286b879f0bc34b693 Mon Sep 17 00:00:00 2001 From: samlhuillier Date: Wed, 16 Oct 2024 16:30:57 -0600 Subject: [PATCH] update welcome note --- src/contexts/FileContext.tsx | 2 +- src/lib/llm/tools/utils.ts | 1 - src/lib/welcome-note.ts | 45 ++++++++++++++++++++++++++++++++++++ 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 src/lib/welcome-note.ts diff --git a/src/contexts/FileContext.tsx b/src/contexts/FileContext.tsx index 16af5f65..0d3286e8 100644 --- a/src/contexts/FileContext.tsx +++ b/src/contexts/FileContext.tsx @@ -34,8 +34,8 @@ import { RichTextLink } from '@/components/Editor/RichTextLink' import '@/styles/tiptap.scss' import SearchAndReplace from '@/components/Editor/Search/SearchAndReplaceExtension' import getMarkdown from '@/components/Editor/utils' -import welcomeNote from '@/components/File/utils' import useOrderedSet from './hooks/use-ordered-set' +import welcomeNote from '@/lib/welcome-note' type FileContextType = { vaultFilesTree: FileInfoTree diff --git a/src/lib/llm/tools/utils.ts b/src/lib/llm/tools/utils.ts index 86ea3749..3af5fe17 100644 --- a/src/lib/llm/tools/utils.ts +++ b/src/lib/llm/tools/utils.ts @@ -84,7 +84,6 @@ export const makeAndAddToolResultToMessages = async ( const toolResult = await createToolResult(toolCallPart.toolName, toolCallPart.args as any, toolCallPart.toolCallId) posthog.capture('tool_executed', { toolName: toolCallPart.toolName, - result: toolResult, }) const toolMessage: CoreToolMessage = { role: 'tool', diff --git a/src/lib/welcome-note.ts b/src/lib/welcome-note.ts new file mode 100644 index 00000000..40ea4494 --- /dev/null +++ b/src/lib/welcome-note.ts @@ -0,0 +1,45 @@ +const welcomeNote = `## Welcome to Reor! + +Reor is a private AI personal knowledge management tool. Our philosophy is that AI should be a thought enhancer not a thought replacer: Reor helps you find & connect notes, discover new insights and enhance your reasoning. + +Some features you should be aware of: + +- **Chat:** + + - Ask your entire set of notes anything you want to know! Reor will automatically give the LLM relevant context. + + - Ask things like “What are my thoughts on philosophy?” or “Summarize my notes on black holes" + + - In settings, you can attach a local LLM or connect to OpenAI models with your API key. + + - LLMs can be provided 'tools' like search, create files, and more. This is powerful for getting the LLM to act agentically in your knowledge base. + + - You can also edit the system prompt provided to the LLM. + +- **Writing assistant:** + + - Reor has a built-in writing assistant that can help you with your writing. + + - You can trigger it by hitting space on a newline or selecting text and hitting the icon that appears. + +- **Links:** + + - Reor automatically links your notes to other notes in the Related Notes sidebar. + + - You can view the Related Notes to a particular chunk of text by highlighting it and hitting the button that appears. + + - You can also create inline links by surrounding text with two square brackets (like in Obsidian). [[Like this]] + +- **AI Flashcards:** + + - Generate flashcards from any note by going to the chat window and hitting the toggle in the bottom right to "Flashcard Ask" mode. + + - Then generate flashcards by running a prompt like "Generate flashcards for this note" + + - Then hit the flashcard icon in the left sidebar to see your flashcards :) + +You can import notes from other apps by adding markdown files to your vault directory. Note that Reor will only read markdown files. + +Please join our [Discord community](https://discord.gg/QBhGUFJYuH) to ask questions, give feedback, and get help. We're excited to have you on board!` + +export default welcomeNote