obsidian-plugin/logancyang_obsidian-copilot
1
0
Fork 0
mirror of https://github.com/logancyang/obsidian-copilot.git synced 2026-07-22 07:50:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
logancyang_obsidian-copilot/docs/index.md
Logan Yang d7d54d2a34
docs: add user-facing documentation (#2254) 
* docs: add user-facing documentation (closes #2253)

- 13 docs covering all major features: getting started, chat interface,
  LLM providers, models/parameters, context/mentions, custom commands,
  vault search/indexing, agent mode/tools, projects, system prompts,
  Copilot Plus/self-host, troubleshooting/FAQ, and index
- Written for non-technical Obsidian users
- Each doc is standalone with cross-references to related docs
- All values verified against source code (defaults, model names, etc.)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: improve user docs with website reference material

- getting-started: add glossary (LLM, API, Token, Context Window,
  Embeddings, RAG, Vector Store) and API key billing note
- chat-interface: add user/AI message buttons (edit, copy, delete,
  insert/replace at cursor, regenerate), [[Note Title]] inline reference
  syntax, Relevant Notes feature, manual Save Chat button, and
  auto-compact user experience note
- context-and-mentions: add PDF context (+ Add context button) and
  image context (drag/drop or image button) methods
- custom-commands: fix placeholder syntax ({} not {selected text}),
  add {FolderPath} variable, note tags must be in note properties,
  add richer example prompts
- llm-providers: add LM Studio CORS requirement, 3rd-party CORS warning
- vault-search-and-indexing: add cost estimation tip (Count total
  tokens command), RangeError/partitioning note, tag property note
- agent-mode-and-tools: add Revert option, note @composer works in
  both Plus and Projects modes
- projects: add 50+ file type support detail
- copilot-plus-and-self-host: add dashboard URL
- troubleshooting-and-faq: add first-steps section, RangeError fix,
  response cut-off fix, notes-not-found checklist, note referencing
  FAQ, English response FAQ, image/PDF FAQ, privacy note

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* chore: remove UI_RENDERING_PERFORMANCE.md from docs (already in designdocs)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: add doc maintenance rule to CLAUDE.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: fix custom command variable syntax and project deletion claim

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: clarify 16 built-in providers + unlimited OpenAI-compatible models

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: fix semantic search default and partitioning claims

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: fix self-host status and remaining partitioning claim

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs: fix self-host setup steps, tool count, and memory tool availability

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-03-03 17:39:00 -08:00

1.9 KiB
Raw Blame History

Copilot for Obsidian — Documentation

Welcome to the official documentation for Copilot for Obsidian, an AI-powered assistant plugin that brings the power of large language models directly into your note-taking workflow.

Table of Contents

Document What it covers
Getting Started Installation, first-time setup, opening the chat panel, keyboard shortcuts
Chat Interface Chat modes, sending messages, history, settings, auto-compact
LLM Providers All 16+ supported providers and how to set them up
Models and Parameters Chat models, embedding models, temperature, max tokens, and other parameters
Context and Mentions Active note context, @-mentions, URLs, tags, and the web viewer
Custom Commands Creating and using preset prompts, template variables, Quick Command, Quick Ask
Vault Search and Indexing Lexical search, semantic search, index management, exclusions
Agent Mode and Tools Autonomous agent, all 13 tools, file editing, web search
Projects Focused workspaces with isolated context, model, and chat history
System Prompts Customizing AI behavior with built-in and custom system prompts
Copilot Plus and Self-Host Copilot Plus features, memory system, self-host mode, Miyo
Troubleshooting and FAQ Common errors, provider-specific issues, performance, FAQ

Quick Start

  1. Install Copilot from Obsidian Community Plugins
  2. Add an API key in Settings → Copilot → Basic → API Keys
  3. Open the chat panel with the robot icon in the left ribbon
  4. Start chatting!

For a full walkthrough, see Getting Started.