LCORE-2505: Add migration guide and deprecation notes for BYOK config refactoring#1882
Open
are-ces wants to merge 2 commits into
Open
LCORE-2505: Add migration guide and deprecation notes for BYOK config refactoring#1882are-ces wants to merge 2 commits into
are-ces wants to merge 2 commits into
Conversation
… refactoring Add docs/migrations/v0.7.0.md with field mapping, full RAG before/after examples, and chunk limit migration table. Add deprecation callouts to byok_guide.md and rag_guide.md linking to the migration guide. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (13)
🧰 Additional context used🧠 Learnings (1)📚 Learning: 2026-06-09T07:59:22.991ZApplied to files:
🔇 Additional comments (1)
WalkthroughThis PR adds v0.7.0 documentation for RAG configuration restructuring, including a new migration guide and deprecation warnings in existing guides for the updated ChangesRAG configuration restructuring documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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. Comment |
Contributor
Author
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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/migrations/v0.7.0.md`:
- Around line 11-27: The migration doc describes moving fields into rag.byok,
rag.okp and rag.retrieval.* but the runtime schema still exposes top-level
byok_rag, okp, reranker and rag.inline/rag.tool and code
(validate_reranker_auto_enable) reads self.reranker and self.rag.inline; update
the doc to match the actual v0.7.0 schema by changing the Field Mapping and
examples to show the current top-level paths (byok_rag, okp, reranker,
rag.inline/rag.tool) OR explicitly mark this migration as targeting a future
schema and add version gating guidance; also mention
validate_reranker_auto_enable, self.reranker, self.rag.inline and the top-level
config names so maintainers can reconcile examples with the runtime model.
🪄 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: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 45cf17c1-0c9a-4824-ae83-763a7dddb35c
📒 Files selected for processing (3)
docs/byok_guide.mddocs/migrations/v0.7.0.mddocs/rag_guide.md
📜 Review details
⏰ 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). (10)
- GitHub Check: E2E Tests for Lightspeed Evaluation job
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: mypy
- GitHub Check: black
- GitHub Check: unit_tests (3.13)
- GitHub Check: unit_tests (3.12)
- GitHub Check: bandit
- GitHub Check: Pylinter
- GitHub Check: build-pr
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
🔇 Additional comments (2)
docs/byok_guide.md (1)
116-123: LGTM!docs/rag_guide.md (1)
66-73: LGTM!Also applies to: 323-328
syedriko
reviewed
Jun 29, 2026
|
|
||
| ### Chunk Limits | ||
|
|
||
| Chunk limits were previously hardcoded as constants in `src/constants.py`. They are now configurable fields in `lightspeed-stack.yaml` with the same default values: |
Contributor
There was a problem hiding this comment.
"Chunk limits have been moved from constants in the code to configurable fields in lightspeed-stack.yaml. The default values of the fields match the previous constants."
?
Contributor
Author
There was a problem hiding this comment.
Verb tense is wrong,
"chunk limits will be moved from constants in the code to configurable fields in lightspeed-stack.yaml"
Contributor
Author
There was a problem hiding this comment.
Fixed the verb tenses over the docs, are you confused by something else?
What it means is that the old constants become configurable in the lightspeed config, and the defaults are unchanged.
Contributor
There was a problem hiding this comment.
It's all good, I just thought why mention a file with code in user-facing docs.
syedriko
approved these changes
Jun 29, 2026
Use future tense since these changes are not yet released. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
syedriko
approved these changes
Jun 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds a v0.7.0 migration guide and deprecation notices for the RAG configuration refactoring (PR #1843 / LCORE-1426). The migration guide documents the move from four separate top-level sections (
byok_rag,rag,okp,reranker) to a unified nestedragsection, including:Deprecation callouts are added to
byok_guide.mdandrag_guide.mdlinking to the migration guide.Type of change
Tools used to create PR
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit
ragsection, including updated BYOK store, retrieval source, OKP, and reranker structure, plus field remapping guidance.lightspeed-stack.yamlfields.