Skip to content

LCORE-1651: Link to upgrade guidance and migration paths for each version#2032

Open
arin-deloatch wants to merge 1 commit into
lightspeed-core:mainfrom
arin-deloatch:docs/LCORE-1651
Open

LCORE-1651: Link to upgrade guidance and migration paths for each version#2032
arin-deloatch wants to merge 1 commit into
lightspeed-core:mainfrom
arin-deloatch:docs/LCORE-1651

Conversation

@arin-deloatch

@arin-deloatch arin-deloatch commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Description

Create docs/migrations/index.md as a central landing page for version migration guides and link it from docs/index.md, docs/README.md, and the root README.md.

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

  • Assisted-by: Claude Code (Claude Opus 4.6)

Related Tickets & Documents

  • Closes LCORE-1651

Checklist before requesting a review

  • I have performed a self-review of my code.
  • PR has passed all pre-merge test jobs.
  • If it is a core feature, I have added thorough tests.

Testing

  • Please provide detailed steps to perform tests related to this code change.
  • How were the fix/results from this change verified? Please provide relevant screenshots or results.

Summary by CodeRabbit

  • Documentation
    • Added a new Migration guides section to the docs navigation and main documentation index.
    • Introduced a dedicated migration guides landing page with upgrade resources organized by release.
    • Updated the versioning documentation to point to migration guidance for upgrading between versions.

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 19a34e1b-e547-4cdb-835a-fbd253b0c494

📥 Commits

Reviewing files that changed from the base of the PR and between 56ae5fd and 9409506.

📒 Files selected for processing (4)
  • README.md
  • docs/README.md
  • docs/index.md
  • docs/migrations/index.md
📜 Recent review details
⏰ Context from checks skipped due to timeout. (14)
  • GitHub Check: radon
  • GitHub Check: ruff
  • GitHub Check: integration_tests (3.13)
  • GitHub Check: Pylinter
  • GitHub Check: build-pr
  • GitHub Check: integration_tests (3.12)
  • GitHub Check: spectral
  • GitHub Check: E2E: library mode / ci / group 2
  • GitHub Check: E2E: server mode / ci / group 2
  • GitHub Check: E2E: library mode / ci / group 3
  • GitHub Check: E2E: library mode / ci / group 1
  • GitHub Check: E2E: server mode / ci / group 3
  • GitHub Check: E2E: server mode / ci / group 1
  • GitHub Check: E2E Tests for Lightspeed Evaluation job
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-06-09T07:59:22.991Z
Learnt from: are-ces
Repo: lightspeed-core/lightspeed-stack PR: 1882
File: docs/migrations/v0.7.0.md:11-27
Timestamp: 2026-06-09T07:59:22.991Z
Learning: When reviewing lightspeed-stack migration documentation, a side-by-side appearance of the old v0.6 top-level configuration keys (e.g., `byok_rag`, `okp`, `reranker`, `rag.inline`, `rag.tool`) and the new v0.7.0 nested `rag.*` configuration paths (e.g., `rag.byok.stores`, `rag.okp`, `rag.retrieval.inline`, `rag.retrieval.tool`, `rag.retrieval.inline.reranker`) is expected and reflects the upgrade/mapping. Do not flag these as schema conflicts as long as the document clearly shows the old paths on the v0.6 side and the corresponding new paths on the v0.7.0 side per the migration guide.

Applied to files:

  • docs/migrations/index.md
🔇 Additional comments (4)
docs/migrations/index.md (1)

1-9: LGTM!

README.md (1)

1381-1382: LGTM!

docs/README.md (1)

38-41: LGTM!

docs/index.md (1)

45-48: LGTM!


Walkthrough

Adds a docs/migrations/index.md page listing migration guides by release version (v0.7.0 RAG config restructure) and adds navigation links to it from README.md, docs/README.md, and docs/index.md.

Changes

Migration Guides Documentation

Layer / File(s) Summary
Migration guides page and navigation links
docs/migrations/index.md, README.md, docs/README.md, docs/index.md
Creates the migrations index with a v0.7.0 entry and wires navigation links from the root README versioning section, docs sidebar, and docs index.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 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 clearly matches the documentation update adding migration guidance links and versioned upgrade paths.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant