Update README.md with slash prompts

[drewkhoury]

Why?

What Changed?

Additional Notes

• Linked relevant spec/task IDs (e.g., tasks/0002-spec-open-source-ready.md)
• Ran tests: uv run pytest
• Ran linters/hooks: uv run pre-commit run --all-files
• Updated docs or prompts if behavior changed

Summary by CodeRabbit

• Documentation
  • Enhanced README with Slash Command usage guide for IDEs
  • Added visual example and descriptive notes after installation instructions to improve user onboarding

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

README.md updated with a descriptive note and inline image demonstrating Slash Command usage within integrated development environments, following the installation instructions section for improved user onboarding.

Changes

Cohort / File(s)	Change Summary
Documentation Enhancement README.md	Added descriptive note and inline image illustrating Slash Command usage within IDEs after install instructions

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Verify inline image reference is correctly formatted and the file path is valid
• Confirm descriptive note is clear and grammatically sound
• Check that documentation placement logically follows install instructions

Poem

🐰 A picture paints where words fall short,
Commands in slashes, neatly sorted,
In IDEs they dance and play,
Making coding a better day! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is a blank template with no actual content filled in—sections like 'Why?', 'What Changed?', and 'Additional Notes' are empty, and all checklist items are unchecked.	Fill in the required sections: explain the motivation under 'Why?', summarize the README changes under 'What Changed?', and complete the checklist items as applicable.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Update README.md with slash prompts' is specific and clearly related to the main change of adding slash command usage documentation to the README.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch drewkhoury-patch-1

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

👋 Thank you for opening this pull request!

We require PR titles to follow the Conventional Commits specification.

Error details:

No release type found in pull request title "Update README.md with slash prompts". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat
 - fix
 - docs
 - style
 - refactor
 - perf
 - test
 - build
 - ci
 - chore
 - revert

Valid format: <type>(<optional scope>): <description>

Valid types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert

Examples:

• feat(auth): add login button to navigation
• fix: resolve race condition in async handler
• docs: update installation instructions

Please update your PR title and the check will run automatically.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

29-31: Enhance clarity of the IDE setup note.

The addition usefully clarifies what happens after running the installation command. However, the opening phrase could be more explicit about what "this" refers to, and the sentence could flow more naturally.

Consider revising to:

-This should apply slash commands in your IDE (eg in Windsurf, in the chat screen. Note you may want to be in Agent or Code mode):
+The above command will install slash commands in your IDE (e.g., in Windsurf, accessible in the chat screen). Note: you may want to be in Agent or Code mode:

The image and alt text are well-formed. This addition usefully guides users on where to find and use the installed commands.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ead128 and cb6389b.

📒 Files selected for processing (1)

• README.md (1 hunks)