LCORE-248: getting started guide, second version #309
Conversation
WalkthroughThe Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Possibly related PRs
Poem
✨ 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/getting_started.md (6)
5-16: Fix TOC indentation & list-marker style (MD007/MD004).
markdownlintflags the current 4-space indent and mixed*/-markers. Two-space indent with consistent*markers keeps the list readable and silences the linter.-* [Preface](#preface) -* [Deployment methods](#deployment-methods) -* [Integration with Llama Stack framework](#integration-with-llama-stack-framework) - * [Llama Stack as a library](#llama-stack-as-a-library) - * [Llama Stack as a server](#llama-stack-as-a-server) -* [Local deployment](#local-deployment) - * [Llama Stack used as a library](#llama-stack-used-as-a-library) - * [Llama Stack used as a separate process](#llama-stack-used-as-a-separate-process) -* [Running from container](#running-from-container) - * [Llama Stack used as a library](#llama-stack-used-as-a-library-1) - * [Llama Stack used as a separate process in container](#llama-stack-used-as-a-separate-process-in-container) - * [Llama Stack configuration](#llama-stack-configuration) +* [Preface](#preface) +* [Deployment methods](#deployment-methods) +* [Integration with Llama Stack framework](#integration-with-llama-stack-framework) + * [Llama Stack as a library](#llama-stack-as-a-library) + * [Llama Stack as a server](#llama-stack-as-a-server) +* [Local deployment](#local-deployment) + * [Llama Stack used as a library](#llama-stack-used-as-a-library) + * [Llama Stack used as a separate process](#llama-stack-used-as-a-separate-process) +* [Running from container](#running-from-container) + * [Llama Stack used as a library](#llama-stack-used-as-a-library-1) + * [Llama Stack used as a separate process in container](#llama-stack-used-as-a-separate-process-in-container) + * [Llama Stack configuration](#llama-stack-configuration)
28-35: Correct typos & unify bullet markers in ‘Deployment methods’.Small wording fixes + switch inner dashes to asterisks for consistency.
-*Lightspeed Core Stack (LCS)* service is built on the Llama Stack framework, which can be run in several modes. Additionally it is possible to run *LCS* locally (as regular application written in Python programming language) or from within container. This means, that is is possible to leverage multiple deploment methods: +*Lightspeed Core Stack (LCS)* is built on the Llama Stack framework, which can be run in several modes. Additionally, it is possible to run *LCS* locally (as a regular Python application) or from within a container. This means that it is possible to leverage multiple deployment methods: -* Local deployment - - Llama Stack framework is used as a library - - Llama Stack framework is used as a separate process (deployed locally) -* Running from a container - - Llama Stack framework is used as a library - - Llama Stack framework is used as a separate process in container +* Local deployment + * Llama Stack framework is used as a library + * Llama Stack framework is used as a separate process (deployed locally) +* Running from a container + * Llama Stack framework is used as a library + * Llama Stack framework is used as a separate process in a container
49-55: Grammar polish in ‘Llama Stack as a library’.-When this mode is selected, Llama Stack is used as a regular Python library. That means, that this library needs to be installed to system Python environment, user Python environment, or to virtual Python environment. All calls to Llama Stack is performed via standard function or method calls: +When this mode is selected, Llama Stack is used as a regular Python library. This means that the library must be installed in the system Python environment, a user-level environment, or a virtual environment. All calls to Llama Stack are performed via standard function or method calls:
60-62: Singular/plural agreement & surplus commas.-When this mode is selected, Llama Stack is started as a separate REST API service. All communications with Llama Stack is thus done via REST API calls, which in turn means, that Llama Stack can run on separate machine if needed. +When this mode is selected, Llama Stack is started as a separate REST API service. All communication with Llama Stack is performed via REST API calls, which means that Llama Stack can run on a separate machine if needed.
64-66: Fix wording & product name in the NOTE.-The REST API scheme and also semantic can change at any time, especially before the official version 1.0.0 will be released. By using *Lighspeed Core Service* developers, users, and customers are isolated from these incompatibilities. +The REST API schema and semantics can change at any time, especially before version 1.0.0 is released. By using *Lightspeed Core Service*, developers, users, and customers stay isolated from these incompatibilities.
71-71: Remove wordiness and tighten the local-deployment intro.-In this chapter it will be shown how to run LCS locally. This mode is especially useful for developers, as it is possible to work with the latest versions of source codes, including locally made changes and improvements. And last but not least, it is possible to trace, monitor and debug the entire system from within integrated development environment etc. +This chapter explains how to run LCS locally. Local deployment is especially useful for developers because it allows working with the latest source code, including local changes. You can also trace, monitor, and debug the entire system from within an integrated development environment.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/getting_started.md
[style] ~71-~71: ‘last but not least’ might be wordy. Consider a shorter alternative.
Context: ...ally made changes and improvements. And last but not least, it is possible to trace, monitor and d...
(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_LEAST)
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
8-8: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
9-9: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
31-31: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(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). (1)
- GitHub Check: e2e_tests
tisnik
force-pushed
the
lcore-248-getting-started-2nd-version
branch
from
658b75b to
0966e71
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/getting_started.md (7)
5-16: Fix nested bullet-point indentation in the TOC
markdownlint(MD007) flags the sub-items because they are indented by four spaces instead of two.
This affects rendering consistency across Markdown viewers and will keep the linter red.-* [Integration with Llama Stack framework](#integration-with-llama-stack-framework) - * [Llama Stack as a library](#llama-stack-as-a-library) - * [Llama Stack as a server](#llama-stack-as-a-server) +* [Integration with Llama Stack framework](#integration-with-llama-stack-framework) + * [Llama Stack as a library](#llama-stack-as-a-library) + * [Llama Stack as a server](#llama-stack-as-a-server) ... -* [Running from container](#running-from-container) - * [Llama Stack used as a library](#llama-stack-used-as-a-library-1) - * [Llama Stack used as a separate process in container](#llama-stack-used-as-a-separate-process-in-container) - * [Llama Stack configuration](#llama-stack-configuration) +* [Running from container](#running-from-container) + * [Llama Stack used as a library](#llama-stack-used-as-a-library-1) + * [Llama Stack used as a separate process in container](#llama-stack-used-as-a-separate-process-in-container) + * [Llama Stack configuration](#llama-stack-configuration)
22-23: Tighten wording in the introductionSmall language tweaks improve clarity:
-It is a service that allows users to communicate with large language models (LLMs), access to RAG databases, call so called agents, process conversation history, ensure that the conversation is only about permitted topics, etc. +It enables users to interact with large language models (LLMs), access RAG databases, invoke so-called agents, process conversation history, and enforce topic restrictions.
28-36: Unify bullet style in “Deployment methods”
markdownlint(MD004) warns because stars (*) and dashes (-) are mixed. Stick to one marker (stars are already used above).-* Local deployment - - Llama Stack framework is used as a library - - Llama Stack framework is used as a separate process (deployed locally) -* Running from a container - - Llama Stack framework is used as a library - - Llama Stack framework is used as a separate process in a container +* Local deployment + * Llama Stack used as a library + * Llama Stack used as a separate process (local) +* Container deployment + * Llama Stack used as a library + * Llama Stack used as a separate process (in container)
41-44: Grammar nit – drop the extra article-... can be run as a standalone server and accessed via its the REST API. +... can be run as a standalone server and accessed via its REST API.
52-56: GitHub Markdown does not render[!NOTE]blocks nativelyUnless the docs site uses a plugin, convert to a standard blockquote so the admonition displays everywhere:
-[!NOTE] -Even when Llama Stack is used as a library, it still requires the configuration file `run.yaml` to be presented. This configuration file is loaded during initialization phase. +> **Note** +> Even when Llama Stack is used as a library, it still requires the configuration file `run.yaml`. +> The file is loaded during the initialization phase.
71-72: Reduce wordiness-... and last but not least, it is possible to trace, monitor and debug the entire system ... +... and, finally, you can trace, monitor, and debug the entire system ...
77-80: Consider explicit numbering for the port listMarkdown auto-numbering with repeated ‘1.’ renders fine but can confuse diff reviews. Using explicit numbers improves readability:
-1. Llama Stack framework with open port 8321 (can be easily changed if needed) -1. LCS with open port 8080 (can be easily changed if needed) +1. Llama Stack framework (default port 8321, configurable) +2. LCS (default port 8080, configurable)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/getting_started.md
[style] ~71-~71: ‘last but not least’ might be wordy. Consider a shorter alternative.
Context: ...ally made changes and improvements. And last but not least, it is possible to trace, monitor and d...
(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_LEAST)
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
8-8: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
9-9: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
12-12: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
14-14: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
15-15: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
16-16: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
31-31: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
31-31: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
32-32: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
32-32: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
34-34: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
34-34: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
35-35: Unordered list style
Expected: asterisk; Actual: dash
(MD004, ul-style)
35-35: Unordered list indentation
Expected: 2; Actual: 4
(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). (2)
- GitHub Check: build-pr
- GitHub Check: e2e_tests
1 participant
Description
LCORE-248: getting started guide, second version
Type of change
Related Tickets & Documents
Summary by CodeRabbit