Skip to content

Commit

Permalink
Update notion_researcher extension (raycast#8490)
Browse files Browse the repository at this point in the history
* Add notion_researcher extension

- Update README.md
- Update README.md
- Merge pull request raycast#8 from razgaon/production-preparation
- Fixed bug with semantic scholar and added toast.
- Merge pull request raycast#7 from razgaon/production-preparation
- Improved Semantic Scholar
- Merge pull request raycast#5 from razgaon/razgaon-readme-patch-1
- Merge pull request raycast#6 from razgaon/production-preparation
- Added automatic database creation.
- Update README.md
- Added image
- Added changelog and categories
- Updated icons
- Fixed lint issues
- Merge pull request raycast#4 from razgaon/feature/create-database
- Improved the UI and experience
- Added clear indication when adding papers
- Merge pull request raycast#3 from razgaon/feature/no-duplicates
- Checks if article already exists.
- Merge pull request raycast#2 from razgaon/feature/speed-enhancment
- Changed llm call to be concurrent with other calls.
- Update README.md
- Merge pull request #1 from razgaon/feature/ml-explainability
- Added ml explaining
- Added support for multiple papers as input

* Fixed lint issue

* Fixed comments

* Fixed additional comments

* Fixed bug in parsing math equations.

* Removed unnecessary backslash

* Changelog

* Update notion_researcher extension

- Merge branch \'contributions/merge-1695255364095020000\'
- Pull contributions
- Added more metadata
- Updated readme
- Updated package lock
- Updated packages
- Completed addConcept feature
- Added concept feature to capture rich text(including math)

* Fixed lint issues

* Changed Metadata images

* Update CHANGELOG.md and optimise images

---------

Co-authored-by: Milena Araujo <milena@raycast.com>
Co-authored-by: raycastbot <bot@raycast.com>
  • Loading branch information
3 people committed Sep 21, 2023
1 parent c50c511 commit 93932b9
Show file tree
Hide file tree
Showing 11 changed files with 1,047 additions and 155 deletions.
78 changes: 55 additions & 23 deletions extensions/notion_researcher/README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,72 @@
# Notion Research Assistant Raycast Extension

This extension is supercharges your research! It allows you to paste **Arxiv** paper urls and automatically add them to a Notion database.
Additionally, references from the paper are added and sorted by number of citations.
If given an OpenAI key, the extension will generate explanations to jargon and concepts from the papers.
All authors are added to enable full-text search on authors inside your Notion workspace.
Enhance your research and learning journey with this powerful Raycast extension for Notion. This extension offers two primary features: **Adding a Concept** and **Adding a Paper** to your Notion workspace.

arXiv is a free distribution service and an open-access archive for scholarly articles.
https://arxiv.org/
## Table of Contents

## Setup
1. [Adding a Concept](#adding-a-concept)
2. [Adding a Paper](#adding-a-paper)
3. [Setup Instructions](#setup-instructions)
- [Notion Integration](#create-a-notion-internal-integration)
- [Extension Activation](#activate-the-extension)
4. [Paper-Specific Setup](#paper-specific-setup)
5. [Concept-Specific Setup](#concept-specific-setup)
6. [Additional Features](#additional-features)

### Create a Notion internal integration:
---

Initially, you will need to create an internal notion integration and use the resulting Notion api key (Public OAuth support will be added soon.)
https://developers.notion.com/docs/authorization
## Adding a Concept

Then, turn on the extension in the page or space where you want to use the extension.
<img width="1792" alt="image" src="https://github.com/razgaon/raycast-notion-research/assets/43913869/86dfeb46-4a3b-4285-a001-7098ba3dacd8">
Are your ChatGPT interactions getting lost in endless threads? The `Adding a Concept` feature lets you effortlessly transfer responses from ChatGPT to a designated Notion database. Simply choose a name for the concept, and let the extension handle the rest.

### Create a database under a page you prefer using the "Create Research Database" command.
---

Note: The page must have a non-empty title.
## Adding a Paper

https://github.com/razgaon/raycast-notion-research/assets/43913869/f66f7275-eb22-43f7-8270-c7d982cf59d1
Effortlessly organize your research papers from **Arxiv** into your Notion database using the `Adding a Paper` command. This feature:

Copy the key and add it to the extension preferences.
- Automatically imports the paper details.
- Sorts references by citation count.
- Generates explanations for jargon and complex concepts if provided with an OpenAI key.
- Enables full-text search for authors within your Notion workspace.

### Add Papers!
> [arXiv](https://arxiv.org/) is a free distribution service and open-access archive for scholarly articles.
To add a paper, simply copy an Arxiv link (or many!) and paste them into the "Add Research Paper" command. Once the papers load, just press enter and you're done!
---

https://github.com/razgaon/raycast-notion-research/assets/43913869/03d514c0-999e-4844-b4dc-d49403c7a74c
## Setup Instructions

# Extras
### Create a Notion Internal Integration

If you want to generate explanations for concepts from papers, you can add your OpenAI key and it will happen automatically (less than 1 cent per paper)
1. Initially, you'll need to set up an internal Notion integration. Follow the guidelines [here](https://developers.notion.com/docs/authorization) to obtain your Notion API key. (Public OAuth support coming soon.)

If you use Readwise Reader, you can add your api key and the extension will automatically add the paper to Reader.
https://readwise.io/read
### Activate the Extension

2. After creating the integration, activate the extension in the desired Notion page or workspace.

![Extension Activation](https://github.com/razgaon/raycast-notion-research/assets/43913869/86dfeb46-4a3b-4285-a001-7098ba3dacd8)

---

## Paper-Specific Setup

1. **Create a Research Database**: Use the "Create Research Database" command to set up a database under your preferred Notion page. (Note: The page must have a non-empty title.)

![Database Creation](https://github.com/razgaon/raycast-notion-research/assets/43913869/f66f7275-eb22-43f7-8270-c7d982cf59d1)

2. **Add Papers**: To add research papers, copy one or multiple Arxiv URLs and paste them into the "Add Research Paper" command. Once loaded, press enter to complete the action.

![Add Papers](https://github.com/razgaon/raycast-notion-research/assets/43913869/03d514c0-999e-4844-b4dc-d49403c7a74c)

---

## Concept-Specific Setup

Create a Notion database with a column named "Title". Locate the database key in the URL and add it to the extension preferences. For example, the database key in the following URL `https://www.notion.so/testuser/c0320379be2440ce8bc48b1889663122?v=b1aa958d689342a5a857a7d46d4835aa` is `c0320379be2440ce8bc48b1889663122`.

---

## Additional Features

- **OpenAI Integration**: To generate explanations for terms and concepts in papers, add your OpenAI API key. (Cost: Less than $0.01 per paper.)
- **Readwise Reader Integration**: If you use [Readwise Reader](https://readwise.io/read), provide your API key and the extension will automatically add papers to your Readwise Reader.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 93932b9

Please sign in to comment.