Skip to content

Enhance documentation for search agent integration workflow#47

Merged
virginia-delos merged 2 commits intomainfrom
25-feature-document-the-full-workflow-retrieval-search-agent-integration
Mar 19, 2026
Merged

Enhance documentation for search agent integration workflow#47
virginia-delos merged 2 commits intomainfrom
25-feature-document-the-full-workflow-retrieval-search-agent-integration

Conversation

@n1colasf
Copy link
Member

Description

This PR improves the documentation for search implementation by making the required workflow explicit and easy to follow from scratch.
It now clearly documents the required order: define a Retrieval, create a Retrieval Tool (Search), and register that search tool in the Agent.

Type of Change

  • Documentation update

Related Issues

Fixes #25

Changes Made

  • Added a dedicated section, Creating a Search from Scratch, with the full 3-step workflow in the docs.
  • Clarified that the Retrieval must be defined first before creating the Search tool.
  • Clarified that the Search must be included in the agent tools list, otherwise it will not be used.
  • Kept examples minimal and clean to improve readability and reduce confusion.

Testing Done

  • Tested manually

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ca7f3b8f00

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@n1colasf n1colasf self-assigned this Mar 18, 2026
@n1colasf n1colasf added the documentation Improvements or additions to documentation label Mar 18, 2026
@cogsol cogsol deleted a comment from chatgpt-codex-connector bot Mar 18, 2026
@virginia-delos virginia-delos self-requested a review March 19, 2026 19:08
@virginia-delos virginia-delos merged commit 5556782 into main Mar 19, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] Document the full workflow: Retrieval → Search → Agent integration

2 participants