No description
Find a file
2025-03-25 13:48:11 -04:00
.github/workflows renemae release job 2025-03-25 12:22:20 -04:00
src fix lint issues 2025-03-25 11:44:48 -04:00
.gitignore work on openai integration 2024-12-24 10:46:24 -05:00
.tool-versions work on release workflow 2025-03-25 11:38:54 -04:00
esbuild.config.mjs add svelte view 2024-12-24 10:15:01 -05:00
eslint.config.mjs work on not using node 2025-02-12 16:03:01 -05:00
knowledge.md Use sentence case everywhere, per Obsidian's plugin guidelines 2025-02-15 11:35:26 -05:00
LICENSE Update LICENSE 2025-03-25 13:46:16 -04:00
main.ts initial commit 2024-12-24 10:00:52 -05:00
manifest.json Update manifest.json 2025-03-25 13:46:46 -04:00
package.json move dep 2025-02-15 11:22:13 -05:00
pnpm-lock.yaml move dep 2025-02-15 11:22:13 -05:00
README.md add more local dev instructions 2024-12-30 10:45:26 -05:00
test-coverage-plan.md improve test coverage 2025-02-12 16:30:41 -05:00
tsconfig.json work on not using node 2025-02-12 16:03:01 -05:00

Research Quest

An Obsidian plugin that uses AI to generate and track research questions based on your notes.

Features

  • Automatically generates relevant research questions from your current document
  • Tracks which questions have been answered in your writing
  • Maintains a list of active and completed research questions
  • Integrates with OpenAI's GPT models for intelligent question generation and analysis

Installation

  1. Install the plugin from Obsidian's Community Plugins
  2. Enable the plugin in Obsidian's settings
  3. Add your OpenAI API key in the plugin settings

Usage

  1. Open a note you want to research further
  2. Click the microscope icon in the ribbon to open the Research Quest view
  3. Click "Refresh" to analyze your current document and generate research questions
  4. Questions will be automatically marked as complete when your document answers them

Development

# Install dependencies
pnpm install

# Run in development mode
pnpm run dev

# Build for production
pnpm run build

# Run tests
pnpm test

Installing local plugin

To install the plugin locally, you'll need to symlink the plugin folder to your Obsidian vault's plugins folder.

ln -s /path/to/research-quest /path/to/obsidian-vault/.obsidian/plugins/research-quest

Once you've created the symlink, you can enable the plugin in Obsidian's community plugins settings.

To avoid needing to re-enable the plugin after each change, you can install the hot-reload Obsidian plugin.

Further reading