generate api docs

2 files changed, 53 insertions, 0 deletions

diff --git a/.rules/default/obsidian.md b/.rules/default/obsidian.md
new file mode 100644
index 0000000..0330edd
--- /dev/null
+++ b/.rules/default/obsidian.md
@@ -0,0 +1,31 @@
+# Obsidian API Docs — AI Note Organizer
+
+This plugin organizes notes via AI powered by Ollama. Docs are in `.rules/docs/obsidian/`.
+
+## Where to Look
+
+| Need to... | File |
+|------------|------|
+| Set up plugin class, `onload`/`onunload`, manifest.json | `.rules/docs/obsidian/plugin-lifecycle.md` |
+| Load/save settings, `loadData()`/`saveData()` | `.rules/docs/obsidian/plugin-lifecycle.md` |
+| Read/write/create/delete/rename files | `.rules/docs/obsidian/vault-api.md` |
+| Modify frontmatter (`processFrontMatter`) | `.rules/docs/obsidian/vault-api.md` |
+| Move files into folders, auto-update links | `.rules/docs/obsidian/vault-api.md` |
+| Batch process notes, build note graph | `.rules/docs/obsidian/vault-api.md` |
+| Query tags, links, headings, frontmatter from cache | `.rules/docs/obsidian/metadata-cache.md` |
+| Find untagged/orphan notes, backlinks | `.rules/docs/obsidian/metadata-cache.md` |
+| Collect vault-wide metadata summary | `.rules/docs/obsidian/metadata-cache.md` |
+| React to file create/modify/delete/rename events | `.rules/docs/obsidian/vault-api.md` + `.rules/docs/obsidian/events-utilities.md` |
+| Wait for metadata cache readiness | `.rules/docs/obsidian/metadata-cache.md` |
+| Call Ollama API (generate, chat, embeddings, list models) | `.rules/docs/obsidian/events-utilities.md` |
+| Handle HTTP requests (`requestUrl`) | `.rules/docs/obsidian/events-utilities.md` |
+| Create custom sidebar/panel views | `.rules/docs/obsidian/workspace-api.md` |
+| Open/navigate files in workspace leaves | `.rules/docs/obsidian/workspace-api.md` |
+| Register commands (global, editor, conditional) | `.rules/docs/obsidian/ui-components.md` |
+| Build settings UI (text, toggle, dropdown, etc.) | `.rules/docs/obsidian/ui-components.md` |
+| Show modals, suggest modals, fuzzy search | `.rules/docs/obsidian/ui-components.md` |
+| Context menus, notices, ribbon, status bar | `.rules/docs/obsidian/ui-components.md` |
+| Manipulate editor content (cursor, selection, insert) | `.rules/docs/obsidian/editor-api.md` |
+| Custom markdown rendering / code blocks | `.rules/docs/obsidian/editor-api.md` |
+| Detect platform (desktop/mobile/OS) | `.rules/docs/obsidian/events-utilities.md` |
+| Use `moment.js`, debounce, protocol handlers | `.rules/docs/obsidian/events-utilities.md` |
diff --git a/.rules/default/ollama.md b/.rules/default/ollama.md
new file mode 100644
index 0000000..cf6f962
--- /dev/null
+++ b/.rules/default/ollama.md
@@ -0,0 +1,22 @@
+# Ollama API Docs — AI Note Organizer
+
+Local LLM inference via Ollama (`http://localhost:11434`). Docs are in `.rules/docs/ollama/`.
+
+## Where to Look
+
+| Need to... | File |
+|------------|------|
+| One-shot text completion, prompt/suffix, system prompt | `.rules/docs/ollama/generate.md` |
+| ModelOptions (temperature, top_k, top_p, seed, num_ctx, stop, etc.) | `.rules/docs/ollama/generate.md` |
+| Structured output via `format` (JSON / JSON schema) | `.rules/docs/ollama/generate.md` |
+| Load / unload a model (`keep_alive`) | `.rules/docs/ollama/generate.md` |
+| Streaming vs non-streaming response handling | `.rules/docs/ollama/generate.md` |
+| Thinking / reasoning traces (`think` param) | `.rules/docs/ollama/generate.md` |
+| Multi-turn conversation (chat history, roles) | `.rules/docs/ollama/chat.md` |
+| Tool / function calling (define tools, handle tool_calls) | `.rules/docs/ollama/chat.md` |
+| ChatMessage, ToolDefinition, ToolCall schemas | `.rules/docs/ollama/chat.md` |
+| Generate vector embeddings from text | `.rules/docs/ollama/embed.md` |
+| Batch embed multiple strings at once | `.rules/docs/ollama/embed.md` |
+| List locally available models | `.rules/docs/ollama/list-models.md` |
+| Get model details (parameters, template, license) | `.rules/docs/ollama/show-model.md` |
+| Check Ollama server version / health | `.rules/docs/ollama/version.md` |