Skip to content

docs: add web-search example to README - #14

Merged
emilsvennesson merged 1 commit into
mainfrom
docs/readme-web-search-example
Apr 10, 2026
Merged

emilsvennesson merged 1 commit into
mainfrom
docs/readme-web-search-example

Conversation

@emilsvennesson

@emilsvennesson emilsvennesson commented Apr 10, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add a concrete README example showing how OpenCode invokes web-search.
  • Show the expected answer format with cited sources.
  • Keep existing provider/setup guidance unchanged.

Copilot AI review requested due to automatic review settings April 10, 2026 21:35
@emilsvennesson
emilsvennesson force-pushed the docs/readme-web-search-example branch from 53230b1 to b162d63 Compare April 10, 2026 21:36
@emilsvennesson emilsvennesson changed the title docs: clarify README and add web-search example docs: add web-search example to README Apr 10, 2026
@emilsvennesson
emilsvennesson merged commit 6e7c2a7 into main Apr 10, 2026
1 check passed
@emilsvennesson
emilsvennesson deleted the docs/readme-web-search-example branch April 10, 2026 21:36

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the README to better explain what the plugin does (adds a web-search tool to an OpenCode session) and to provide a concrete usage example that demonstrates tool invocation and source citation.

Changes:

  • Clarifies the opening description to explicitly mention the web-search tool.
  • Adds a new README example showing a web-search query and cited sources.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +13 to +16
> ⚙ `web-search` [query=latest PostgreSQL release version April 2026]
>
> As of now (April 2026), the latest PostgreSQL community release is PostgreSQL 18.3.
> If you mean the latest major version line, that is PostgreSQL 18.

Copilot AI Apr 10, 2026

Copy link

Choose a reason for hiding this comment

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

The README example hard-codes a specific month/year and exact PostgreSQL version ("As of now (April 2026) ... PostgreSQL 18.3"). This will become outdated quickly and can be incorrect depending on when/where the README is read. Consider making the output explicitly illustrative (e.g., omit exact version numbers/dates or phrase it as a sample response) so the docs stay accurate over time.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +20 to +21
> - [PostgreSQL Roadmap](https://www.postgresql.org/developer/roadmap/)
> - [PostgreSQL News Archive (2026-02-26 release)](https://www.postgresql.org/about/newsarchive/-/20260226/)

Copilot AI Apr 10, 2026

Copy link

Choose a reason for hiding this comment

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

The source link points to a specific dated news-archive entry ("2026-02-26 release"). Dated deep links are more likely to rot or stop matching the example over time; a more stable target (e.g., PostgreSQL main news page or general releases page) would keep the example durable.

Copilot uses AI. Check for mistakes.
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.

2 participants