mirror of
https://github.com/epistemic-technology/co-intelligence.git
synced 2026-07-22 06:45:17 +00:00
Add test vault and development docs
Add a test vault with sample content and a script to build and open it in Obsidian for manual plugin testing. Add development section to README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
638d33dc7f
commit
e3377004a2
7 changed files with 75 additions and 0 deletions
29
README.md
29
README.md
|
|
@ -107,6 +107,35 @@ I am an idependent software developer. If you find Co-Intelligence to be useful,
|
|||
|
||||
[<img style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi6.png?v=6' border='0' alt='Buy Me a Coffee at ko-fi.com' />](https://ko-fi.com/X8X71G7YSI)
|
||||
|
||||
## Development
|
||||
|
||||
### Setup
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev # Watch mode — rebuilds on file changes
|
||||
npm run build # Production build (also validates TypeScript types)
|
||||
npm test # Run tests with Vitest
|
||||
```
|
||||
|
||||
### Manual Testing
|
||||
|
||||
A test vault is included at `test-vault/` so you can test the plugin in Obsidian without affecting your personal vault. To build and open it:
|
||||
|
||||
```bash
|
||||
./scripts/open-test-vault.sh
|
||||
```
|
||||
|
||||
The first time you open the vault, you'll need to enable community plugins in Settings > Community plugins. After that, the Co-Intelligence AI plugin will be pre-enabled.
|
||||
|
||||
The script symlinks the build output (`dist/`) into the test vault's plugin directory, so rebuilds are picked up automatically. For a live development workflow:
|
||||
|
||||
1. Run `npm run dev` in one terminal
|
||||
2. Run `./scripts/open-test-vault.sh` to open the vault
|
||||
3. After changes rebuild, reload Obsidian (Cmd/Ctrl+P > "Reload app without saving")
|
||||
|
||||
The test vault includes sample folders and system prompts for exercising plugin features.
|
||||
|
||||
## Contributing, Feedback, and Help
|
||||
|
||||
This is an open source project, using the [MIT License](LICENSE). Pull requests for bug fixes or small improvements are welcome. If you want to get involved in a more substantial way, please [Contact me](https://epistemic.technology/contact/).
|
||||
|
|
|
|||
23
scripts/open-test-vault.sh
Executable file
23
scripts/open-test-vault.sh
Executable file
|
|
@ -0,0 +1,23 @@
|
|||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
||||
PROJECT_DIR="$(dirname "$SCRIPT_DIR")"
|
||||
VAULT_DIR="$PROJECT_DIR/test-vault"
|
||||
PLUGIN_DIR="$VAULT_DIR/.obsidian/plugins/co-intelligence"
|
||||
|
||||
# Create plugin directory and symlinks
|
||||
mkdir -p "$PLUGIN_DIR"
|
||||
ln -sf "$PROJECT_DIR/dist/main.js" "$PLUGIN_DIR/main.js"
|
||||
ln -sf "$PROJECT_DIR/dist/styles.css" "$PLUGIN_DIR/styles.css"
|
||||
ln -sf "$PROJECT_DIR/manifest.json" "$PLUGIN_DIR/manifest.json"
|
||||
|
||||
# Build latest
|
||||
echo "Building plugin..."
|
||||
npm --prefix "$PROJECT_DIR" run build
|
||||
|
||||
# Open the test vault in Obsidian
|
||||
echo "Opening test vault in Obsidian..."
|
||||
open "obsidian://open?path=$(python3 -c "import urllib.parse; print(urllib.parse.quote('$VAULT_DIR'))")"
|
||||
|
||||
echo "Done. If this is the first time, enable the plugin in Settings > Community plugins."
|
||||
7
test-vault/.gitignore
vendored
Normal file
7
test-vault/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Obsidian generates config files when the vault is opened.
|
||||
# Only community-plugins.json is checked in (to pre-enable the plugin).
|
||||
.obsidian/*
|
||||
!.obsidian/community-plugins.json
|
||||
|
||||
# Plugin symlinks are machine-specific; the script recreates them.
|
||||
.obsidian/plugins/
|
||||
1
test-vault/.obsidian/community-plugins.json
vendored
Normal file
1
test-vault/.obsidian/community-plugins.json
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
["co-intelligence"]
|
||||
1
test-vault/coi/prompts/Code reviewer.md
Normal file
1
test-vault/coi/prompts/Code reviewer.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
You are a code reviewer. Review code for bugs, style issues, and potential improvements. Be constructive and specific.
|
||||
1
test-vault/coi/prompts/Helpful assistant.md
Normal file
1
test-vault/coi/prompts/Helpful assistant.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
You are a helpful assistant. Be concise and clear in your responses.
|
||||
13
test-vault/notes/Sample note.md
Normal file
13
test-vault/notes/Sample note.md
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
This is a sample note for testing context linking in Co-Intelligence AI.
|
||||
|
||||
## Key points
|
||||
|
||||
- First point with **bold** and *italic* formatting
|
||||
- Second point with a `code snippet`
|
||||
- Third point with a [[link to nowhere]]
|
||||
|
||||
```javascript
|
||||
function hello() {
|
||||
console.log("Hello from a code block");
|
||||
}
|
||||
```
|
||||
Loading…
Reference in a new issue