add agent-eval deprecation note

[asamal4]

Summary by CodeRabbit

Documentation

• Removed Agent Evaluation documentation section from the main README.
• Added a deprecation notice to the evaluation tool documentation indicating the tool is not maintained and will be deprecated following migration to a new evaluation system.

[coderabbitai]

Walkthrough

Two documentation updates addressing the Agent Evaluation feature: removal of its reference from the main README and addition of a deprecation notice to the dedicated lsc_agent_eval/README.md file.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md, lsc_agent_eval/README.md	Main README removes Agent Evaluation section; lsc_agent_eval/README adds deprecation notice indicating the evaluation tool is unmaintained and will be deprecated upon migration to new evaluation tool.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only changes with no logic, error handling, or control flow modifications
• Straightforward content removal and editorial addition

Possibly related PRs

• update readme #54: Modifies README content regarding Agent Evaluation feature—removing it from main README and deprecating lsc_agent_eval documentation.

Suggested reviewers

• VladimirKadlec
• tisnik

Poem

🐰 ✨ The docs take a bow,
Agent Eval says goodbye for now,
Deprecation notices so bright,
Guide the way to futures light,
Clean and clear, a rabbit's delight! 🥕

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title 'add agent-eval deprecation note' is directly related to the main changes in the changeset. The raw summary confirms that a deprecation notice was inserted at the top of lsc_agent_eval/README.md, and a documentation section was removed from README.md. The title accurately captures the primary objective of this PR: adding deprecation information for the agent evaluation tool.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a181e5 and 676765c.

📒 Files selected for processing (2)

• README.md (0 hunks)
• lsc_agent_eval/README.md (1 hunks)

💤 Files with no reviewable changes (1)

• README.md

🧰 Additional context used

📓 Path-based instructions (1)

lsc_agent_eval/**

📄 CodeRabbit inference engine (AGENTS.md)

Do not add or modify code in lsc_agent_eval/ (legacy, unmaintained)

Files:

• lsc_agent_eval/README.md

🧠 Learnings (4)

📓 Common learnings

Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-16T11:17:19.324Z
Learning: Applies to lsc_agent_eval/** : Do not add or modify code in lsc_agent_eval/ (legacy, unmaintained)

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 19
File: lsc_agent_eval/tests/core/agent_goal_eval/test_script_runner.py:0-0
Timestamp: 2025-07-16T12:07:29.169Z
Learning: In the lsc_agent_eval package, the ScriptRunner class was modified to use absolute paths internally rather than documenting path normalization behavior, providing more predictable and consistent path handling.

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 19
File: lsc_agent_eval/data/script/eval3/setup.sh:1-3
Timestamp: 2025-07-16T09:42:00.691Z
Learning: Scripts in the lsc_agent_eval/data directory are meant to be simple examples/samples for teams to customize according to their needs, not production-ready code.

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 19
File: lsc_agent_eval/tests/core/agent_goal_eval/test_evaluator.py:274-297
Timestamp: 2025-07-16T10:41:09.399Z
Learning: In the lsc_agent_eval package, the team prefers to focus on core functionality testing first and considers testing cleanup script execution after setup failure as early optimization, noting that there's no guarantee cleanup scripts will run successfully anyway.

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 47
File: src/lightspeed_evaluation/core/output/generator.py:140-145
Timestamp: 2025-09-11T12:47:06.747Z
Learning: User asamal4 prefers that non-critical comments are sent when actual code changes are pushed, not on unrelated commits.

📚 Learning: 2025-10-16T11:17:19.324Z

Learnt from: CR
Repo: lightspeed-core/lightspeed-evaluation PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-10-16T11:17:19.324Z
Learning: Applies to lsc_agent_eval/** : Do not add or modify code in lsc_agent_eval/ (legacy, unmaintained)

Applied to files:

• lsc_agent_eval/README.md

📚 Learning: 2025-07-16T12:07:29.169Z

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 19
File: lsc_agent_eval/tests/core/agent_goal_eval/test_script_runner.py:0-0
Timestamp: 2025-07-16T12:07:29.169Z
Learning: In the lsc_agent_eval package, the ScriptRunner class was modified to use absolute paths internally rather than documenting path normalization behavior, providing more predictable and consistent path handling.

Applied to files:

• lsc_agent_eval/README.md

📚 Learning: 2025-08-26T11:17:48.640Z

Learnt from: asamal4
Repo: lightspeed-core/lightspeed-evaluation PR: 28
File: lsc_eval/runner.py:99-103
Timestamp: 2025-08-26T11:17:48.640Z
Learning: The lsc_eval generic evaluation tool is intended to become the primary evaluation framework, replacing an existing evaluation tool in the lightspeed-evaluation repository.

Applied to files:

• lsc_agent_eval/README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)

• GitHub Check: ruff
• GitHub Check: mypy
• GitHub Check: pydocstyle
• GitHub Check: tests (3.13)
• GitHub Check: tests (3.12)
• GitHub Check: tests (3.11)

🔇 Additional comments (1)

lsc_agent_eval/README.md (1)

5-5: Deprecation notice appropriately positioned and clearly communicated.

The deprecation notice is well-placed at the top of the README and clearly communicates that the tool is unmaintained and will be deprecated once migration to the new evaluation framework is complete. The link to the new evaluation tool provides a clear migration path for users.

However, note that this change modifies a file within lsc_agent_eval/, which is flagged in the coding guidelines as legacy/unmaintained. While this is a documentation change rather than a code modification, please confirm this deprecation notice addition aligns with the intended approach for maintaining legacy package documentation.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[VladimirKadlec]

LGTM