Docs

The full documentation lives with the plugin on GitHub — ameen278/Study-Agent. Start with the guides below; developer docs are linked for contributors.

How to use

How the agent works ↗

What happens when you send a message, sidebar controls, and what is sent where.

Skills — how to use them ↗

Built-in and custom skills, with examples for Study help, Revision, and Summarize.

AI providers ↗

Setup per provider, privacy notes, and protocol specifics.

Code explained (developer docs)

End-to-end flow ↗

Request bodies, error handling, and troubleshooting at the code level.

ChatView structure and model line ↗

Sidebar modules, system-prompt assembly, and the skill dropdown.

Streaming ↗

How streaming, stopping, and the non-streaming fallback work.

OllamaService reference ↗

The service layer behind every provider call.

Settings reference ↗

Stored shape, migration rules, and the settings-tab UI.

Markdown rendering ↗

How replies render as live Markdown.

Thinking switch and copy icon ↗

Implementation notes for the sidebar controls.

Copy-icon fix and Thinking indicator ↗

History and fixes for the copy and thinking UX.

UI improvements ↗

Notes on the sidebar UI evolution.

Contributing

The plugin is GPL-3.0-or-later. To build from source:

Terminal

npm install
npm run dev      # rebuild on change
npm run build    # type-check and production bundle
npm run lint     # ESLint with Obsidian rules

Browse the code · Report a bug or request a feature · Releases

Project: Study Agent on Obsidian Community · Author: Ameen (ameen278) · License: GPL-3.0-or-later