Make it clear what the LCORE config filename needs to be in getting started

[bparees]

Description

The existing doc didn't tell you what the lcore config filename needed to be, it just showed the content that goes into it.

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

Related Tickets & Documents

• Related Issue #
• Closes #

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
  • Updated setup instructions to clarify the creation of the required configuration file for running the Lightspeed Core Service with Llama Stack.

[coderabbitai]

Walkthrough

The documentation in docs/getting_started.md was updated to include an explicit step instructing users to create a lightspeed-stack.yaml file with the provided YAML configuration before running the Lightspeed Core Service with Llama Stack in library mode.

Changes

Cohort / File(s)	Change Summary
Getting Started Documentation docs/getting_started.md	Added explicit instruction to create a lightspeed-stack.yaml file with the given YAML configuration for LCS setup.

Sequence Diagram(s)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• LCORE-248: Getting started guide, 4th version #322: Also updates the same documentation to improve guidance on running LCS with Llama Stack, complementing this PR's explicit file creation step.
• LCORE-248: Stub for Getting started guide #301: Updates docs/getting_started.md to enhance setup instructions for Llama Stack, related to this PR's added clarity.
• LCORE-248: getting started guide, second version #309: Focuses on improving the same documentation file for setting up and using Lightspeed Core Service with Llama Stack.

Poem

A YAML file, so neat and bright,
Guides the stack to run just right.
With docs now clear, the path is shown,
Llama Stack in library mode is known.
Hop along, set up with glee—
The rabbit cheers: "Configuration, whee!" 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

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

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/getting_started.md (2)

64-64: Avoid pinning a specific lightspeed-stack version in sample output

Hard-coding lightspeed-stack==0.1.3 in the “uv add” resolution example risks becoming stale and confusing readers when newer versions are released. Consider either:

1. Removing the line entirely from the captured output, or
2. Replacing the exact version with <latest> / x.y.z to signal that the concrete value may differ.

This keeps the docs future-proof and reduces maintenance overhead.

---

248-248: Good clarity—consider adding file location hint

The new sentence clearly tells users to create lightspeed-stack.yaml, nice! For completeness, you could append “in the repository root” (or the exact expected directory) so newcomers don’t wonder where to place it.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8cc0ac7 and 417338d.

📒 Files selected for processing (1)

• docs/getting_started.md (1 hunks)

⏰ 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). (1)

• GitHub Check: e2e_tests

[tisnik]

LGTM, thank you.