Skip to content

docs: Add OpenCode examples and documentation to README.#23

Open
sanathusk wants to merge 2 commits intojohnlindquist:mainfrom
sanathusk:main
Open

docs: Add OpenCode examples and documentation to README.#23
sanathusk wants to merge 2 commits intojohnlindquist:mainfrom
sanathusk:main

Conversation

@sanathusk
Copy link
Copy Markdown

@sanathusk sanathusk commented Feb 19, 2026

Add OpenCode examples and documentation to README.

Summary by CodeRabbit

  • Documentation
    • README updated to document OpenCode as a supported agent with usage guidance
    • Quick Start and usage sections expanded to include OpenCode workflows for interactive and non-interactive modes
    • New OpenCode example(s) and command examples added to illustrate common tasks and interactive scenarios

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b1c702 and 75fd5a2.

📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md and its usage sections were updated to add OpenCode as a supported agent/command, including new example references (explain.opencode.md, task.opencode.md, task.i.opencode.md, refactor.opencode.md) and an OpenCode example block in Quick Start and interactive/standard command examples.

Changes

Cohort / File(s) Summary
Documentation Updates
README.md
Added OpenCode agent/command references and examples (explain.opencode.md, task.opencode.md, task.i.opencode.md, refactor.opencode.md). Updated Quick Start, non-interactive and interactive command example sections to include OpenCode usage and an OpenCode example block.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇 I hopped through docs with a cheerful code song,
OpenCode now hums where examples belong,
Quick starts and tasks, a new agent to greet,
Refactors and prompts make the README complete. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: Add OpenCode examples and documentation to README' accurately and specifically describes the main change: adding OpenCode-related documentation and examples to the README file.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 410-418: Replace the ephemeral model ID used in the README example
(the string "opencode/glm-5-free" inside the OpenCode example block) with a
stable, long-lived model identifier (e.g., "opencode/gpt-5.1-codex" or another
supported OpenCode model); update the example markdown block under the
"OpenCode" section so the model field references the durable model ID and ensure
the surrounding example text still makes sense with the new model name.

Comment thread README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant