-
Notifications
You must be signed in to change notification settings - Fork 457
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4af7c30
commit a507306
Showing
3 changed files
with
46 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |