Skip to content

docs: promote web search proposal to ADR-0009#119

Merged
alexeykazakov merged 1 commit into
codeready-toolchain:masterfrom
alexeykazakov:docs/promote-web-search-adr
May 13, 2026
Merged

docs: promote web search proposal to ADR-0009#119
alexeykazakov merged 1 commit into
codeready-toolchain:masterfrom
alexeykazakov:docs/promote-web-search-adr

Conversation

@alexeykazakov
Copy link
Copy Markdown
Contributor

@alexeykazakov alexeykazakov commented May 13, 2026

  • Distill design + questions docs into architecture decision record
  • Consolidate 9 design decisions into rationale table
  • Remove implementation details, keep architectural contracts
  • Delete source proposal files from docs/proposals/

Summary by CodeRabbit

  • Documentation
    • Updated web search architecture documentation to reflect implemented status with detailed decisions, revised security walkthrough, and enhanced configuration guidance.
    • Consolidated design questions into the primary reference, removing the separate proposal document.

- Distill design + questions docs into architecture decision record
- Consolidate 9 design decisions into rationale table
- Remove implementation details, keep architectural contracts
- Delete source proposal files from docs/proposals/

Signed-off-by: Alexey Kazakov <alkazako@redhat.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

Walkthrough

This PR updates the web-search ADR status from "Final" to "Implemented" and consolidates decision rationale with detailed explanations of API key delivery, provider configuration, proxy injection, and CRD schema handling. A separate proposal-questions document is removed as decisions are now integrated into the ADR.

Changes

ADR Consolidation and Status Update

Layer / File(s) Summary
Status and decision documentation
docs/adr/0009-web-search.md (lines 1–4, 20–33)
Document status changes from "Final" to "Implemented"; a comprehensive "Decisions" table is added documenting design choices for API key delivery, provider selection, placeholder handling, and web fetch behavior.
Architecture and security clarification
docs/adr/0009-web-search.md (lines 92–92)
Gateway configuration step is refined to explicitly state the static placeholder apiKey injection while the proxy ultimately delivers the real credential.
CRD schema and proxy configuration refinement
docs/adr/0009-web-search.md (lines 150–187)
CRD schema documentation adds a YAML-oriented example with spec.webSearch and spec.webFetch, and proxy configuration is rewritten with a provider→domain→injector mapping table clarifying CRED_WEBSEARCH secret mounting and Secret ResourceVersion stamping.
ConfigMap and cleanup
docs/adr/0009-web-search.md (lines 202–295)
ConfigMap injection documentation refines Gemini behavior (no placeholder apiKey; user config merges into plugins.entries.google.config.webSearch), and the "Implementation Plan" section is removed, leaving "Future Considerations" as the conclusion.

Proposal Document Cleanup

Layer / File(s) Summary
Remove obsolete proposal questions
docs/proposals/web-search-questions.md (deleted)
The standalone Q&A proposal document is removed; decision rationale is now consolidated in the ADR.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested labels

documentation, proposal

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately reflects the main change: promoting a web search proposal to ADR-0009 by consolidating design decisions and removing source proposal files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot added documentation Improvements or additions to documentation proposal Add or update documentation that mirrors the canonical plan for a major feature initiative labels May 13, 2026
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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/adr/0009-web-search.md`:
- Line 202: Change the lowercase provider name to the proper noun "Google" in
the documentation text: replace references to models.providers.google.apiKey and
plugins.entries.google.config.webSearch where they are described in prose (e.g.,
"google LLM provider") so the phrase reads "Google LLM provider" while leaving
the actual config keys (models.providers.google.apiKey and
plugins.entries.google.config.webSearch) unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: 9d9991f4-3494-40ad-be4e-8a27695c210f

📥 Commits

Reviewing files that changed from the base of the PR and between 0f979fe and f86045c.

📒 Files selected for processing (2)
  • docs/adr/0009-web-search.md
  • docs/proposals/web-search-questions.md
💤 Files with no reviewable changes (1)
  • docs/proposals/web-search-questions.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

-Focus on major issues impacting performance, readability, maintainability and security. Avoid nitpicks and avoid verbosity.

Files:

  • docs/adr/0009-web-search.md
🪛 LanguageTool
docs/adr/0009-web-search.md

[uncategorized] ~202-~202: “Google” is a proper noun and needs to be capitalized.
Context: ...ders.google.apiKey` already set for the google LLM provider. User-provided config for ...

(A_GOOGLE)

Comment thread docs/adr/0009-web-search.md
@alexeykazakov alexeykazakov merged commit 8bb1ffb into codeready-toolchain:master May 13, 2026
4 checks passed
@alexeykazakov alexeykazakov deleted the docs/promote-web-search-adr branch May 13, 2026 01:18
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 proposal Add or update documentation that mirrors the canonical plan for a major feature initiative

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant