LCORE-248: Getting started guide, 3rd version #316
Conversation
WalkthroughThe "Getting started" documentation was extensively expanded and reorganized, especially in the "Local deployment" section for running Llama Stack as a separate process. The update introduces detailed step-by-step instructions, new configuration examples, command outputs, and verification steps, transforming the guide into a comprehensive resource for local deployment and integration with LCS. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
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
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
/retest |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
docs/getting_started.md (2)
12-20: Normalize ToC list indentation to satisfy markdown-lint MD007.Current sub-items are indented with 8 spaces; GitHub-flavoured Markdown expects 4 (or 2) for a second-level list.
-* [Local deployment](#local-deployment) - * [Prerequisites](#prerequisites) +* [Local deployment](#local-deployment) + * [Prerequisites](#prerequisites)Apply the same 4-space indentation pattern for all nested ToC entries.
This keeps rendering consistent across Markdown engines and eliminates the linter warnings.
191-206: Add language identifiers to bare fenced blocks (MD040).Several code / log excerpts open with plain ````` but no language hint, triggering MD040 and reducing syntax-highlighting:
-``` +```text usage: llama [-h] ...Repeat for the exception trace, server log,
make runoutput and the finalcurlresponse block.Affected opening fences start at lines 191, 212, 377, 559 and 578.
Also applies to: 212-228, 377-381, 559-563, 578-592
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
12-12: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
19-19: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
20-20: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
21-21: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
23-23: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
191-191: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
212-212: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
377-377: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
559-559: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
578-578: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ 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: build-pr
| * [Prerequisities](#prerequisities) | ||
| * [Installation of all required tools](#installation-of-all-required-tools) | ||
| * [Installing dependencies for Llama Stack](#installing-dependencies-for-llama-stack) | ||
| * [Check if Llama Stack can be started](#check-if-llama-stack-can-be-started) | ||
| * [Llama Stack configuration](#llama-stack-configuration) | ||
| * [Run Llama Stack in a separate process](#run-llama-stack-in-a-separate-process) | ||
| * [LCS configuration to connect to Llama Stack running in separate process](#lcs-configuration-to-connect-to-llama-stack-running-in-separate-process) |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix repeated typo – “Prerequisities” → “Prerequisites”.
The word is miss-spelled in both the ToC and section headers which also breaks generated anchor links.
- * [Prerequisities](#prerequisities)
+ * [Prerequisites](#prerequisites)
-#### Prerequisities
+#### Prerequisites
-* [Prerequisities](#prerequisities-1)
+* [Prerequisites](#prerequisites-1)
-#### Prerequisities
+#### PrerequisitesAlso applies to: 21-21, 94-100, 598-600
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
13-13: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
17-17: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
18-18: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
🤖 Prompt for AI Agents
In docs/getting_started.md around lines 12 to 18, 21, 94 to 100, and 598 to 600,
the word "Prerequisities" is misspelled and should be corrected to
"Prerequisites" in both the table of contents and section headers. Update all
instances of this typo to fix the spelling and ensure that the generated anchor
links work correctly.
1 participant
Description
LCORE-248: Getting started guide, 3rd version
Type of change
Related Tickets & Documents
Summary by CodeRabbit