Onboarding improvements: 15-minute quickstart, fix Windows date & Obsidian path, safe mission insertion, accurate Claude init messaging, unify vault naming, update links
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Complete Setup Guide
|
||||
|
||||
This guide will walk you through setting up your Obsidian + Claude Code PKM system step by step. Total time: ~30 minutes.
|
||||
This guide will walk you through setting up your Obsidian + Claude Code PKM system step by step. Total time: ~15 minutes if prerequisites are installed.
|
||||
|
||||
## Prerequisites Checklist
|
||||
|
||||
@@ -29,7 +29,7 @@ claude --version
|
||||
|
||||
```bash
|
||||
# Option A: If you have git
|
||||
git clone https://github.com/yourusername/obsidian-claude-pkm.git
|
||||
git clone https://github.com/ballred/obsidian-claude-pkm.git
|
||||
cd obsidian-claude-pkm
|
||||
|
||||
# Option B: Download ZIP
|
||||
@@ -60,14 +60,14 @@ The setup script will:
|
||||
|
||||
```bash
|
||||
# Copy vault template to your preferred location
|
||||
cp -r vault-template ~/Documents/MyPKM
|
||||
cp -r vault-template ~/Documents/ObsidianPKM
|
||||
|
||||
# The .claude/commands directory is already included in the template
|
||||
# Verify commands are present
|
||||
ls ~/Documents/MyPKM/.claude/commands/
|
||||
ls ~/Documents/ObsidianPKM/.claude/commands/
|
||||
|
||||
# Initialize git
|
||||
cd ~/Documents/MyPKM
|
||||
cd ~/Documents/ObsidianPKM
|
||||
git init
|
||||
```
|
||||
|
||||
@@ -103,7 +103,7 @@ When prompted:
|
||||
|
||||
```bash
|
||||
# Navigate to your vault
|
||||
cd ~/Documents/MyPKM
|
||||
cd ~/Documents/ObsidianPKM
|
||||
|
||||
# Initialize Claude Code
|
||||
claude init
|
||||
@@ -170,7 +170,7 @@ gh repo create my-pkm --private
|
||||
|
||||
# Or create manually on GitHub.com
|
||||
# Then add remote:
|
||||
git remote add origin https://github.com/yourusername/my-pkm.git
|
||||
git remote add origin https://github.com/ballred/my-pkm.git
|
||||
|
||||
# Push to GitHub
|
||||
git push -u origin main
|
||||
|
||||
@@ -12,7 +12,7 @@ Common issues and their solutions. If you can't find your issue here, check the
|
||||
|
||||
2. **Check File Permissions**
|
||||
```bash
|
||||
ls -la ~/YourVault
|
||||
ls -la ~/Documents/ObsidianPKM
|
||||
# Should show your user as owner
|
||||
```
|
||||
|
||||
@@ -38,7 +38,7 @@ Common issues and their solutions. If you can't find your issue here, check the
|
||||
**Solutions**:
|
||||
1. Check folder exists:
|
||||
```bash
|
||||
cd ~/Documents/YourVault
|
||||
cd ~/Documents/ObsidianPKM
|
||||
ls -la
|
||||
```
|
||||
|
||||
@@ -371,8 +371,8 @@ git config --global core.autocrlf true
|
||||
#### Permission Denied
|
||||
```bash
|
||||
# Fix permissions
|
||||
chmod -R 755 ~/YourVault
|
||||
chown -R $USER:$USER ~/YourVault
|
||||
chmod -R 755 ~/Documents/ObsidianPKM
|
||||
chown -R $USER:$USER ~/Documents/ObsidianPKM
|
||||
```
|
||||
|
||||
#### Missing Dependencies
|
||||
@@ -410,14 +410,14 @@ git checkout COMMIT_HASH -- path/to/file.md
|
||||
If vault is corrupted:
|
||||
```bash
|
||||
# 1. Backup current vault
|
||||
cp -r ~/YourVault ~/YourVault.backup
|
||||
cp -r ~/Documents/ObsidianPKM ~/Documents/ObsidianPKM.backup
|
||||
|
||||
# 2. Create fresh vault
|
||||
cp -r vault-template ~/NewVault
|
||||
|
||||
# 3. Copy your notes
|
||||
cp -r ~/YourVault.backup/Daily\ Notes/* ~/NewVault/Daily\ Notes/
|
||||
cp -r ~/YourVault.backup/Projects/* ~/NewVault/Projects/
|
||||
cp -r ~/Documents/ObsidianPKM.backup/Daily\ Notes/* ~/NewVault/Daily\ Notes/
|
||||
cp -r ~/Documents/ObsidianPKM.backup/Projects/* ~/NewVault/Projects/
|
||||
|
||||
# 4. Reinitialize Git
|
||||
cd ~/NewVault
|
||||
@@ -477,7 +477,7 @@ rm -rf node_modules .obsidian/cache
|
||||
### Resources
|
||||
- [Obsidian Forum](https://forum.obsidian.md/)
|
||||
- [Claude Code Docs](https://docs.anthropic.com/en/docs/claude-code)
|
||||
- [GitHub Issues](https://github.com/yourusername/obsidian-claude-pkm/issues)
|
||||
- [GitHub Issues](https://github.com/ballred/obsidian-claude-pkm/issues)
|
||||
|
||||
### Debug Information
|
||||
When asking for help, provide:
|
||||
@@ -496,7 +496,7 @@ git status
|
||||
git remote -v
|
||||
|
||||
# Vault structure
|
||||
ls -la ~/YourVault
|
||||
ls -la ~/Documents/ObsidianPKM
|
||||
```
|
||||
|
||||
### Community Support
|
||||
|
||||
Reference in New Issue
Block a user