Initial Obsidian plugin release repository

2026-04-27 12:18:37 +08:00
commit 96ec7adc5b
7 changed files with 385 additions and 0 deletions
@@ -0,0 +1,100 @@
+# LLM-Wiki Obsidian Plugin
+
+Desktop-only Obsidian community plugin for Phase 2 of LLM-Wiki.
+
+## What it does
+
+- right-sidebar chat panel for discussing the active wiki page with Claude Code
+- Save Insight action that persists assistant output through `scripts/lw2-save-insight`
+- Fast Research tab that runs an isolated read-only Claude research turn and can promote useful output through Save Insight
+- Deep Research workbench that uses Claude sessions to iteratively refine a draft before registering it with `scripts/lw2-deep-research`
+- source trust badges in edit/preview modes with mutation routed through `scripts/lw2-source-trust`
+- batch source-trust updates for all page sources from the current note
+- command-palette entries for `Run LLM-Wiki compile preflight` and `Run LLM-Wiki lint deterministic pass`
+- confidence-tag styling for inline markers such as `*EXTRACTED 0.95*`
+
+## Current compile/lint scope
+
+The Obsidian plugin currently exposes:
+
+- `Run LLM-Wiki compile preflight`
+- `Run LLM-Wiki lint deterministic pass`
+
+These are deterministic script entrypoints, not the full prompt-owned Claude compile workflow. That means:
+
+- compile currently runs the conservative `scripts/lw2-compile` preflight and reports the manifest state
+- lint currently runs `scripts/lw2-lint`
+- the full semantic wiki-compilation workflow is still centered on the Claude Code `lw2:compile` skill
+
+## Development
+
+```bash
+cd apps/obsidian-lw2
+npm install
+npm test
+npm run build
+npm run release:bundle
+npm run release:community-staging -- --license /path/to/LICENSE
+```
+
+Repo-level regression:
+
+```bash
+cd /home/charles/workspaces/notes/my-llm-wiki
+npm run test:obsidian
+```
+
+Release bundle output:
+
+- directory: `apps/obsidian-lw2/release/lw2-obsidian-<version>/`
+- zip: `apps/obsidian-lw2/release/lw2-obsidian-<version>.zip` when `zip` is available
+
+The release bundle contains:
+
+- `main.js`
+- `manifest.json`
+- `styles.css`
+- `versions.json`
+- `README.md`
+- `INSTALL.md`
+
+Community-repo staging:
+
+- command: `npm run release:community-staging -- --license /path/to/LICENSE`
+- output: `apps/obsidian-lw2/release/community-repo/`
+
+This exports a directory shaped like an Obsidian community-plugin repository root. It intentionally fails unless you provide a real `LICENSE` file path.
+
+## Local loading in Obsidian
+
+1. Build the package: `npm run build`
+2. Copy or symlink `apps/obsidian-lw2/` into your vault at `.obsidian/plugins/lw2-obsidian/`
+3. Enable **LLM-Wiki Obsidian** in Community Plugins
+4. Open plugin settings and set:
+   - runtime root: absolute path to the LLM-Wiki runtime repo
+   - Claude command: usually `claude`
+   - Claude plugin dir: `plugins/lw2`
+   - the opened Obsidian vault remains the content root; it does not need to contain `scripts/` or `plugins/lw2/`
+5. Run the manual checklist in [`../../tests/live/obsidian-plugin-checklist.md`](../../tests/live/obsidian-plugin-checklist.md)
+
+## Third-Party Manual Install
+
+1. Build the release bundle with `npm run release:bundle`
+2. Copy `main.js`, `manifest.json`, and `styles.css` from `release/lw2-obsidian-<version>/` into:
+   - `.obsidian/plugins/lw2-obsidian/`
+3. Enable **LLM-Wiki Obsidian**
+4. Point `runtime root` at an external LLM-Wiki runtime checkout
+
+This plugin does not embed the full LLM-Wiki runtime. Third-party installs still need a separate runtime root.
+
+## Official Community Plugin Path
+
+The recommended publication model is:
+
+1. build the plugin here
+2. export `release/community-repo/`
+3. push that directory into a dedicated release repository
+4. publish GitHub releases from that repository
+5. submit that repository to Obsidian's community plugin index
+
+This monorepo is the development source of truth, not the ideal official marketplace repository root.