Update the AGENTS.md with additional knowledge on the telco-reference…

[imiller0]

… repository

[openshift-ci]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: imiller0

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 [imiller0]

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

[coderabbitai]

📝 Walkthrough

Walkthrough

Added comprehensive documentation to AGENTS.md covering component deployment ordering using sync-waves, component registration requirements, PolicyGenerator templating syntax with hub functions, and testing/validation workflows including make commands and kube-compare validation expectations.

Changes

Cohort / File(s)	Summary
Documentation AGENTS.md	Added "Working with References" section with Hub, Core, and RAN deployment guidance; "Hub-Side Templating" section documenting PolicyGenerator syntax and constraints; "Testing and Validation" section describing validation workflows and runtime expectations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly indicates the main change is updating AGENTS.md with additional telco-reference knowledge, which matches the actual documentation additions to that file.
Description check	✅ Passed	The description is minimal but related to the changeset, mentioning the telco-reference repository which is the context for the AGENTS.md updates made in this pull request.
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]

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 `@AGENTS.md`:
- Around line 151-153: The docs incorrectly instruct running the non-existent
root-level make target "make compare"; update AGENTS.md to either (a) call the
correct subdirectory invocation(s) where the "compare" target actually lives
(e.g., cd into the specific subdirectory(s) and run make compare there) or (b)
add a root-level "compare" make target that delegates to the subdirectory
compare targets (similar to the existing "ci-validate" delegation), ensuring the
README references the chosen approach and that the target name "compare" is
accurate.

🪄 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: Pro Plus

Run ID: 5fe023d3-0467-4eb5-a443-43353d11b4f8

📥 Commits

Reviewing files that changed from the base of the PR and between 3ae5cb7 and b0bc2a3.

📒 Files selected for processing (1)

• AGENTS.md

[coderabbitai]

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify make targets at root and subdirectory levels

echo "=== Root Makefile targets ==="
grep -E '^[a-zA-Z_-]+:' Makefile | head -20

echo -e "\n=== Searching for 'compare' targets in subdirectories ==="
fd -t f '^Makefile$' -x grep -l 'compare:' {}

echo -e "\n=== Examining compare target definitions ==="
rg -A2 '^compare:' --type make

Repository: openshift-kni/telco-reference

Length of output: 1305

---

Incorrect make target: make compare does not exist at repository root.

The documentation instructs users to run make compare, but this target only exists in specific subdirectory Makefiles, not at the root level where users would naturally execute it. Users following these instructions will encounter a "No rule to make target 'compare'" error.

📝 Suggested correction

Update the documentation to specify the correct subdirectory commands:

-make compare  # Validates sync between deployable and validation variants
+# Run from respective configuration directories:
+cd telco-ran/configuration/kube-compare-reference && make compare
+cd telco-hub/configuration/reference-crs-kube-compare && make compare

Alternatively, add a root-level compare target that delegates to subdirectories (similar to ci-validate).

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	```bash
	make compare # Validates sync between deployable and validation variants
	```

🧰 Tools

🪛 markdownlint-cli2 (0.22.0)

[warning] 151-151: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@AGENTS.md` around lines 151 - 153, The docs incorrectly instruct running the
non-existent root-level make target "make compare"; update AGENTS.md to either
(a) call the correct subdirectory invocation(s) where the "compare" target
actually lives (e.g., cd into the specific subdirectory(s) and run make compare
there) or (b) add a root-level "compare" make target that delegates to the
subdirectory compare targets (similar to the existing "ci-validate" delegation),
ensuring the README references the chosen approach and that the target name
"compare" is accurate.

[imiller0]

/hold