docs: modernize Windsurf integration with Rules engine#134
docs: modernize Windsurf integration with Rules engine#134juanitourquiza wants to merge 3 commits intoaddyosmani:mainfrom
Conversation
The existing windsurf-setup.md was outdated and described a manual copy-paste approach using the deprecated .windsurfrules file. Windsurf has since evolved to support a sophisticated Rules system with activation modes, AGENTS.md, and native skills. This commit: - Rewrites docs/windsurf-setup.md to cover the modern Rules engine: * Global Rules via global_rules.md (intent mapping for all projects) * Workspace Rules with model_decision trigger (on-demand activation) * AGENTS.md integration for directory-specific conventions * Activation modes table and best practices - Adds scripts/install-windsurf.sh: automated installer that: * Detects OS * Copies skills to ~/.agents/skills/ * Creates global_rules.md with intent mapping * Optionally installs workspace rules and AGENTS.md - Updates README.md quick-start summary to mention both global and workspace-local Windsurf options Co-authored-by: juanitourquiza <juanitourquiza@gmail.com>
|
Substantive PR and the old doc was genuinely outdated. A few concerns worth addressing before merge:
|
…essive skill checking - Generate global_rules.md dynamically from skills/*/SKILL.md frontmatter (21 skills, no drift) - Add confirmation prompt and timestamped backup before overwriting ~/.agents/skills/ - Move Anti-Rationalization block from global rules to workspace rules (opt-in per project) - Soften language from 'always check skills, even 1% chance' to 'substantive task matches' - Update docs to reference script-generated rules instead of duplicating content
Problem
The existing
docs/windsurf-setup.mdwas outdated. It described:.windsurfrules(deprecated)Windsurf has evolved significantly. It now supports:
global_rules.md) — applies to all workspaces.windsurf/rules/*.md) — with activation modes (always_on,model_decision,glob,manual)Solution
This PR modernizes the Windsurf integration to match the current platform capabilities:
Changes
docs/windsurf-setup.mdcompletely:global_rules.mdfor intent mapping across all projects.windsurf/rules/*.mdand activation modesAGENTS.mdintegration.windsurfrulesapproachscripts/install-windsurf.sh— automated installer that:~/.agents/skills/global_rules.mdwith full intent mapping and lifecycle rulesagent-skills.md,test-driven-development.md,spec-driven-development.md,debugging-and-error-recovery.md,code-review-and-quality.md)AGENTS.mdtemplateREADME.md— Windsurf quick-start summary now mentions both global (install-windsurf.sh) and workspace-local optionsVerification
Tested locally on macOS:
bash scripts/install-windsurf.sh~/.codeium/windsurf/memories/global_rules.mdcreated~/.agents/skills/populated with 21 skills.windsurf/rules/Why This Matters
This brings the Windsurf integration to parity with the OpenCode and Claude Code integrations:
/commandneeded)model_decisiononly loads skills when relevant)Files changed: 3 files (+568 lines, -26 lines)