SETUP.md.tmpl
3.9 KB110 lines
---type: setupscope: project-roottags:- setup- onboarding- obsidian- coworkcreated: [YYYY-MM-DD]updated: [YYYY-MM-DD]---<!--SETUP.md: Step-by-step setup for both Obsidian and Cowork.Goal: get a new install of this project running in under 10 minutes.Order: open as Obsidian vault first, then connect to Cowork. Obsidianopening is faster and lets the user verify file structure before payingthe Cowork setup cost.--># [PROJECT NAME]: SetupGet this project running in Obsidian and Cowork in under 10 minutes.## Prerequisites- Obsidian installed- Cowork installed and signed in- [Any required MCP / tool / account access, listed specifically]- [Any required local files or folder structure already in place]## Steps### 1. Open as Obsidian vaultObsidian → File → Open folder as vault → select this folder ([PROJECT-PATH]).On first open, Obsidian creates a `.obsidian/` config folder. Default settings work fine. If you want graph view to be useful, enable: Settings → Core plugins → Backlinks, Graph view, Outline.### 2. Verify vault structureAfter opening, the file explorer should show:- Root reference files: [[CLAUDE]], [[MEMORY]], [[HEARTBEAT]], [[CHANGELOG]], [[DECISIONS]], [[MODEL_GUIDE]], [[SETUP]], [[SKILLS_REFERENCE]], [[README]], [[00-Index]]- Numbered folders: `01-Knowledge/`, `02-Working/`, `03-Outputs/`, plus `_attachments/` and `_templates/`If anything is missing, the project wasn't fully generated. Check [[CHANGELOG]] for the init entry and re-run generation if needed.### 3. Create the Cowork projectCowork → New Project → point it at this folder ([PROJECT-PATH]).### 4. Paste custom instructions into CoworkOpen [[CLAUDE]]. Copy everything below the YAML frontmatter (everything from the first `#` heading down). Paste into Cowork's Project Settings → Custom Instructions.The "Reference index" section at the bottom of CLAUDE.md is intentional context for Claude, so keep it in the paste.### 5. Set the default model in CoworkIn Project Settings, set the default model to **[MODEL]**. See [[MODEL_GUIDE]] for which model handles which task.### 6. Connect MCPs / toolsThis project uses:- [MCP / tool]: [scope. E.g., "Gmail, read access only"]- [MCP / tool]: [scope]Verify each is connected and authorized before starting.### 7. Verify knowledge baseOpen [[01-Knowledge/KNOWLEDGE_INDEX]]. Confirm the listed files exist. Fill any `[TBD]` slots before running the validation task.### 8. Verify scoped CLAUDE files (if any)Check [[CLAUDE]] under "Subdirectory reference files." If any `CLAUDE-[scope].md` files are listed, confirm they exist and match what the index claims.### 9. Run the validation taskFirst-run validation: [SPECIFIC TASK, e.g., "Ask Claude to summarize 01-Knowledge/sample-input.csv into the format defined in CLAUDE.md."]Expected output: [What success looks like.]If the validation task fails, the most common causes are: [2-3 likely issues, each with a one-line fix.]### 10. Initialize HEARTBEATUpdate [[HEARTBEAT]]:- Set `last-updated` (frontmatter and body) to today- Set `status` (frontmatter) to `idle`- Set "Current objective" to "Idle, awaiting next task"This is your starting state.## Maintenance- After significant work, append a [[CHANGELOG]] entry.- When you change scope, instructions, model assignments, or vault structure, write a [[DECISIONS]] entry.- Review [[MEMORY]] monthly (or whenever it stops feeling accurate).- If you add a subdirectory `CLAUDE-[scope].md` file, log it in [[CLAUDE]] under "Subdirectory reference files."## Useful Obsidian features for this vault- **Graph view**: visualize connections between files. Wikilinks make this work.- **Backlinks pane**: see what links to the file you're reading.- **Tag pane**: navigate by tag taxonomy. See [[MEMORY]] for active tags.- **Quick switcher** (Cmd/Ctrl + O): jump to any file by name.- **Templates plugin**: point it at `_templates/` to use the project's note templates.