OCPBUGS-72557: Address logonoff review comments on AI documentation #15903

sg00dwin · 2026-01-09T21:10:07Z

Fix outdated extension system examples, replace make commands with yarn scripts, clarify SDK re-export architecture, and reduce duplication by referencing authoritative sources.
Assisted-by Claude code

openshift-ci-robot · 2026-01-09T21:10:16Z

@sg00dwin: This pull request references Jira Issue OCPBUGS-72557, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.22.0) matches configured target version for branch (4.22.0)
bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

The bug has been updated to refer to the pull request using the external bug tracker.

Details

In response to this:

Fix outdated extension system examples, replace make commands with yarn scripts, clarify SDK re-export architecture, and reduce duplication by referencing authoritative sources.
Assisted-by Claude code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

coderabbitai · 2026-01-09T21:10:30Z

Walkthrough

Three documentation files updated: development commands now reference frontend yarn workflows; architecture docs formalize JSONC-based plugin extension schema, naming and SDK guidance; conventions updated to prefer core package implementation with SDK re-exports and revised i18n usage.

Changes

Cohort / File(s)	Summary
Development Setup Instructions `AGENTS.md`	Replaced top-level `make` targets with frontend-scoped commands (`cd frontend && yarn install
Plugin Architecture & Extension Schema `ARCHITECTURE.md`	Reworked dynamic plugin guidance to use `console-extensions.json` (JSONC) as canonical extension source; converted inline TS extension examples to JSONC `console.*` typed entries and `$codeRef` lazy-load patterns; expanded extension types summary and public API re-export verification guidance.
Conventions & i18n / SDK Guidance `CONVENTIONS.md`	Changed recommendation from default SDK-first to prefer implementing in core packages then re-export to SDK; updated i18n guidance from `%namespace~key%` to `useTranslation('namespace')` usage; expanded ES6+ / modern JS guidance.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 14beb76 and 6302141.

📒 Files selected for processing (2)

AGENTS.md
ARCHITECTURE.md

🧰 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:

ARCHITECTURE.md
AGENTS.md

🔇 Additional comments (6)

ARCHITECTURE.md (4)

39-68: JSON example looks syntactically correct.

The extension definitions follow the documented console.* naming convention and demonstrate proper use of $codeRef for lazy loading and %namespace~key% for i18n strings.

108-108: Verify the plugin-api-review.md file exists in the .claude/commands/ directory.

The ARCHITECTURE.md references a workflow document at .claude/commands/plugin-api-review.md. Confirm this file exists and is properly linked.

25-29: Verify referenced documentation files exist and confirm extension type count.

The ARCHITECTURE.md lines 25-29 reference three specific SDK documentation files:

frontend/packages/console-dynamic-plugin-sdk/README.md

frontend/packages/console-dynamic-plugin-sdk/docs/console-extensions.md

frontend/packages/console-dynamic-plugin-sdk/docs/api.md

Additionally, the claim of "75+ extension types" should be verified by counting actual extension type definitions in the codebase.

Run the provided verification script to confirm file existence and validate the extension type count before merging.

87-94: Update the verification directive to include all SDK re-export source files.

The internal-*.ts pattern is incomplete. While it captures re-exports from @console/shared, @console/topology, and @console/dynamic-plugin-sdk, it misses useResolvedExtensions.ts which contains the @console/plugin-sdk re-export. Additionally, internal-types.ts contains only type definitions, not actual re-exports.

For accurate verification of all listed packages, check: frontend/packages/console-dynamic-plugin-sdk/src/api/internal-api.ts, internal-console-api.ts, internal-topology-api.ts, and useResolvedExtensions.ts.

Likely an incorrect or invalid review comment.

AGENTS.md (2)

22-34: LGTM! Yarn commands correctly replace make targets.

The transition from make commands to yarn scripts is consistent and correct. All frontend commands properly navigate to the frontend directory before executing, and the full build path (./build.sh) is appropriately distinguished from frontend-only builds.

72-73: Verify the SDK README file path exists before approval.

The reference to frontend/packages/console-dynamic-plugin-sdk/README.md needs manual verification to confirm the file exists at this location and contains relevant plugin development documentation.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

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

sg00dwin · 2026-01-09T21:11:04Z

/verified by @sg00dwin

openshift-ci-robot · 2026-01-09T21:11:19Z

@sg00dwin: This PR has been marked as verified by @sg00dwin.

Details

In response to this:

/verified by @sg00dwin

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

logonoff · 2026-01-09T22:32:39Z

ARCHITECTURE.md

-// GOOD – Dynamic extensions (runtime-loaded)
-export const plugin: Plugin = [
+
+Dynamic plugins define their extensions in a `console-extensions.json` file (JSONC format) located in the plugin package root. Extension types use the naming convention `console.foo/bar`.


I'd like to point claude to read frontend/packages/console-dynamic-plugin-sdk/README.md since it's very very detailed

you may want to reference #15398 for AGENTS.md as well

#15398 was closed as stale. Added a comment for Sam asking if it will be picked up and merged at some point.

Can we still point AI to read our existing docs to reduce duplication in our docs?

logonoff · 2026-01-09T22:33:40Z

ARCHITECTURE.md

+The dynamic plugin SDK re-exports APIs from multiple Console packages:
+- **`@console/shared`** - Dashboard components, UI components, hooks
+- **`@console/internal`** - Core UI, editors, hooks, K8s utilities
+- **`@console/plugin-sdk`** - Extension system, plugin infrastructure
+- **`@console/app`** - Application context


we also export from topology plugin, maybe it's safer to just ask it to check every time..? but may be an unneeded use of tokens

logonoff

I'd like @spadgett to also review this PR as well

logonoff · 2026-01-19T17:44:05Z

AGENTS.md

-make build            # Production build
+cd frontend && yarn lint       # ESLint + Prettier
+cd frontend && yarn test       # Jest unit tests
+cd frontend && yarn build      # Production build


Suggested change

cd frontend && yarn build # Production build

./build-frontend-sh # Production build

logonoff · 2026-01-19T17:45:22Z

ARCHITECTURE.md

-// GOOD – Dynamic extensions (runtime-loaded)
-export const plugin: Plugin = [
+
+Dynamic plugins define their extensions in a `console-extensions.json` file (JSONC format) located in the plugin package root. Extension types use the naming convention `console.foo/bar`.


Can we still point AI to read our existing docs to reduce duplication in our docs?

Assisted-by Claude code

- Add SDK README as primary extension types reference - Include SDK README in AGENTS.md plugin development section - Add missing @console/topology to re-exported packages - Update verification to check internal-*.ts files

sg00dwin · 2026-01-26T21:46:00Z

@logonoff ready for tag and approval

logonoff

Great! Leaves more context room to use

/lgtm

rhamilto · 2026-01-27T18:29:14Z

/approve

openshift-ci · 2026-01-27T18:29:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: logonoff, rhamilto, sg00dwin

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [rhamilto]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2026-01-27T19:07:36Z

@sg00dwin: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot · 2026-01-27T19:12:09Z

@sg00dwin: Jira Issue Verification Checks: Jira Issue OCPBUGS-72557
✔️ This pull request was pre-merge verified.
✔️ All associated pull requests have merged.
✔️ All associated, merged pull requests were pre-merge verified.

Jira Issue OCPBUGS-72557 has been moved to the MODIFIED state and will move to the VERIFIED state when the change is available in an accepted nightly payload. 🕓

Details

In response to this:

Fix outdated extension system examples, replace make commands with yarn scripts, clarify SDK re-export architecture, and reduce duplication by referencing authoritative sources.
Assisted-by Claude code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

sg00dwin assigned logonoff Jan 9, 2026

openshift-ci bot requested review from jhadvig, spadgett and yapei January 9, 2026 21:10

openshift-ci-robot added the verified Signifies that the PR passed pre-merge verification criteria label Jan 9, 2026

logonoff reviewed Jan 9, 2026

View reviewed changes

openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Jan 14, 2026

sg00dwin added the verified Signifies that the PR passed pre-merge verification criteria label Jan 14, 2026

logonoff reviewed Jan 19, 2026

View reviewed changes

sg00dwin added 3 commits January 26, 2026 16:30

Address logonoff review comments on AI documentation

eda79b1

Assisted-by Claude code

Additional tweaks

4d7f51a

sg00dwin force-pushed the OCPBUGS-72557-follow-on-ai-agents branch from 6302141 to 4d7f51a Compare January 26, 2026 21:39

openshift-ci-robot removed the verified Signifies that the PR passed pre-merge verification criteria label Jan 26, 2026

sg00dwin added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jan 26, 2026

logonoff approved these changes Jan 26, 2026

View reviewed changes

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jan 26, 2026

sg00dwin added the verified Signifies that the PR passed pre-merge verification criteria label Jan 27, 2026

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 27, 2026

openshift-merge-bot bot merged commit c1a5050 into openshift:main Jan 27, 2026
4 checks passed

	cd frontend && yarn build # Production build
	./build-frontend-sh # Production build

OCPBUGS-72557: Address logonoff review comments on AI documentation #15903

OCPBUGS-72557: Address logonoff review comments on AI documentation #15903

Conversation

sg00dwin commented Jan 9, 2026

Uh oh!

openshift-ci-robot commented Jan 9, 2026

Uh oh!

coderabbitai bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

sg00dwin commented Jan 9, 2026

Uh oh!

openshift-ci-robot commented Jan 9, 2026

Uh oh!

logonoff Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sg00dwin Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

logonoff Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

logonoff Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

logonoff left a comment

Choose a reason for hiding this comment

Uh oh!

logonoff Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

logonoff Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

sg00dwin commented Jan 26, 2026

Uh oh!

logonoff left a comment

Choose a reason for hiding this comment

Uh oh!

rhamilto commented Jan 27, 2026

Uh oh!

openshift-ci bot commented Jan 27, 2026

Uh oh!

openshift-ci bot commented Jan 27, 2026

Uh oh!

Uh oh!

openshift-ci-robot commented Jan 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai bot commented Jan 9, 2026 •

edited

Loading

logonoff Jan 9, 2026 •

edited

Loading

sg00dwin Jan 14, 2026 •

edited

Loading

logonoff Jan 9, 2026 •

edited

Loading