# your-papa/obsidian-smart2brain architecture

> Architecture diagram of the GitHub repository your-papa/obsidian-smart2brain, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/your-papa/obsidian-smart2brain
- Repository: https://github.com/your-papa/obsidian-smart2brain

## Overview

##### Project type and purpose
- This is a full-stack Obsidian plugin (“Your Smart Second Brain”) built in TypeScript and Svelte.
- It embeds and retrieves your Markdown notes via a RAG (Retrieval-Augmented Generation) pipeline and lets you chat with a local or cloud LLM (e.g. Ollama daemon or OpenAI).

##### File structure
- Top-level: Obsidian plugin metadata (manifest.json), build configs (vite.config.ts, svelte.config.ts, tsconfig.json), styling (tailwind.config.js).
- src/SmartSecondBrain.ts: plugin bootstrap—registers views, commands, settings.
- src/views: three “view” classes that hook into Obsidian’s pane system—Chat, Onboarding, Settings.
- src/components: Svelte UI components for chat interface, modals, settings, onboarding flow, base controls.
- src/controller: business logic and adapters—Messages.ts orchestrates the RAG pipeline; Ollama.ts and OpenAI.ts handle LLM calls.
- src/store.ts: Svelte store for state management; src/lang & i18n.ts: localization; logging.ts: centralized logging.

##### README for additional insights
- Describes a RAG pipeline embedding vault notes into vectors, retrieving by similarity, and then generating answers.
- Supports two LLM integration modes: local via Ollama (CLI or REST), or cloud via OpenAI API.
- Mentions external vector store technologies (Orama) and Langchain in the backend.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Actors
    User(("User")):::external

    subgraph "Obsidian Host"
        subgraph "SmartSecondBrain Plugin"
            subgraph "Core"
                Core1["SmartSecondBrain.ts"]:::core
                Core2["main.ts"]:::core
            end

            subgraph "UI Layer - Views"
                ChatView["Chat.ts"]:::ui
                OnboardingView["Onboarding.ts"]:::ui
                SettingsView["Settings.ts"]:::ui
            end

            subgraph "UI Layer - Components"
                ChatComp["Chat.svelte"]:::ui
                InputComp["Input.svelte"]:::ui
                MessageComp["MessageContainer.svelte"]:::ui
                QuickSettings["QuickSettingsDrawer.svelte"]:::ui
                OnboardComp["Onboarding.svelte"]:::ui
                InitButton["InitButton.svelte"]:::ui
                OllamaApp["OllamaApp.svelte"]:::ui
                OllamaDaemonComp["OllamaDaemon.svelte"]:::ui
                OllamaSetup["OllamaSetup.svelte"]:::ui
                OpenAIOnboard["OpenAI.svelte"]:::ui
                PullOllama["PullOllamaModel.svelte"]:::ui
                SettingsComp["Settings.svelte"]:::ui
                SettingContainer["SettingContainer.svelte"]:::ui
                SettingsOllama["Ollama.svelte"]:::ui
                SettingsOpenAI["OpenAI.svelte"]:::ui
                IncognitoToggle["IncognitoToggle.svelte"]:::ui
                FFExclude["FFExclude.svelte"]:::ui
                ButtonBase["Button.svelte"]:::ui
                DropdownBase["Dropdown.svelte"]:::ui
                LoadingAnim["LoadingAnimation.svelte"]:::ui
                ProgressBar["ProgressBar.svelte"]:::ui
                ProgressCircle["ProgressCircle.svelte"]:::ui
                SliderBase["Slider.svelte"]:::ui
                TextBase["Text.svelte"]:::ui
                ToggleBase["Toggle.svelte"]:::ui
            end

            subgraph "Controller Layer"
                Messages["Messages.ts"]:::controller
                OllamaAdpt["Ollama.ts"]:::controller
                OpenAIAdpt["OpenAI.ts"]:::controller
            end

            subgraph "State Layer"
                Store["store.ts"]:::state
                I18n["i18n.ts"]:::state
                LangFiles["en.json (and other locales)"]:::state
                Logging["logging.ts"]:::state
            end

            subgraph "Data Layer"
                Vault["Vault Notes (Markdown)"]:::data
                Vector["Vector Store (Orama)"]:::data
            end
        end
    end

    subgraph "External Services"
        OllamaService["Ollama Daemon"]:::external
        OpenAIService["OpenAI API"]:::external
    end

    %% Relationships
    User -->|"opens chat"| ChatView
    ChatView -->|"sends message"| Messages
    Messages -->|"indexes/queries"| Vector
    Messages -->|"embed/generate"| OllamaAdpt
    Messages -->|"embed/generate"| OpenAIAdpt
    Messages -->|"update state"| Store
    Store -->|"state update"| ChatComp
    Store -->|"state update"| OnboardingView
    Store -->|"state update"| SettingsView
    Vault -->|"read notes"| Messages
    OllamaAdpt -->|"requests"| OllamaService
    OpenAIAdpt -->|"requests"| OpenAIService

    %% Click Events - Core
    click Core1 "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/SmartSecondBrain.ts"
    click Core2 "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/main.ts"

    %% Click Events - Views
    click ChatView "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/views/Chat.ts"
    click OnboardingView "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/views/Onboarding.ts"
    click SettingsView "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/views/Settings.ts"

    %% Click Events - Components
    click ChatComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Chat/Chat.svelte"
    click InputComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Chat/Input.svelte"
    click MessageComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Chat/MessageContainer.svelte"
    click QuickSettings "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Chat/QuickSettingsDrawer.svelte"
    click OnboardComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/Onboarding.svelte"
    click InitButton "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/InitButton.svelte"
    click OllamaApp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/OllamaApp.svelte"
    click OllamaDaemonComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/OllamaDaemon.svelte"
    click OllamaSetup "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/OllamaSetup.svelte"
    click OpenAIOnboard "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/OpenAI.svelte"
    click PullOllama "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Onboarding/PullOllamaModel.svelte"
    click SettingsComp "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/Settings.svelte"
    click SettingContainer "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/SettingContainer.svelte"
    click SettingsOllama "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/Ollama.svelte"
    click SettingsOpenAI "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/OpenAI.svelte"
    click IncognitoToggle "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/IncognitoToggle.svelte"
    click FFExclude "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/Settings/FFExclude.svelte"
    click ButtonBase "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/Button.svelte"
    click DropdownBase "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/Dropdown.svelte"
    click LoadingAnim "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/LoadingAnimation.svelte"
    click ProgressBar "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/ProgressBar.svelte"
    click ProgressCircle "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/ProgressCircle.svelte"
    click SliderBase "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/Slider.svelte"
    click TextBase "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/Text.svelte"
    click ToggleBase "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/components/base/Toggle.svelte"

    %% Click Events - Controller
    click Messages "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/controller/Messages.ts"
    click OllamaAdpt "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/controller/Ollama.ts"
    click OpenAIAdpt "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/controller/OpenAI.ts"

    %% Click Events - State
    click Store "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/store.ts"
    click I18n "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/lang/i18n.ts"
    click LangFiles "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/lang/en.json"
    click Logging "https://github.com/your-papa/obsidian-smart2brain/blob/main/src/logging.ts"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366D6
    classDef controller fill:#D0FFD6,stroke:#028A0F
    classDef data fill:#FFE8B3,stroke:#D97706
    classDef external fill:#F3D6FF,stroke:#6B21A8
    classDef state fill:#FFE1E6,stroke:#B91C1C
    classDef core fill:#E5E7EB,stroke:#6B7280
```
