Skip to content

LCORE-247: fixed notes in Getting started guide #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 1 commit into from
Aug 3, 2025
Merged

LCORE-247: fixed notes in Getting started guide #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ When this mode is selected, Llama Stack is used as a regular Python library. Thi

![Llama Stack as library](./llama_stack_as_library.svg)

[!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` to be presented. This configuration file is loaded during initialization phase.



Expand All @@ -102,8 +102,8 @@ When this mode is selected, Llama Stack is started as a separate REST API servic

![Llama Stack as service](./llama_stack_as_service.svg)

[!NOTE]
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.
> [!NOTE]
> 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.



Expand Down Expand Up @@ -989,8 +989,8 @@ First, it is needed to get an image containing the *Lightspeed Core Stack* servi

- `podman` installed and configured properly

[!NOTE]
It is possible to use `docker` instead of `podman`, but this use case is not tested and thus not supported.
> [!NOTE]
> It is possible to use `docker` instead of `podman`, but this use case is not tested and thus not supported.



Expand Down Expand Up @@ -1048,11 +1048,11 @@ a4982f43195537b9eb1cec510fe6655f245d6d4b7236a4759808115d5d719972
1. Llama Stack framework with open port 8321 (can be easily changed if needed)
1. Image with LCS with open port 8080 mapped to local port 8080 (can be easily changed if needed)

[!NOTE]
Please note that LCS service will be run in a container. Llama Stack itself can be run in a container, in separate local process, or on external machine. It is just needed to know the URL (including TCP port) to connect to Llama Stack.
> [!NOTE]
> Please note that LCS service will be run in a container. Llama Stack itself can be run in a container, in separate local process, or on external machine. It is just needed to know the URL (including TCP port) to connect to Llama Stack.

[!NOTE]
If Llama Stack is started from a container or is running on separate machine, you can skip next parts - it is expected that everything is setup accordingly.
> [!INFO]
> If Llama Stack is started from a container or is running on separate machine, you can skip next parts - it is expected that everything is setup accordingly.
Comment on lines +1051 to +1055
Copy link
Contributor

@coderabbitai coderabbitai bot Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Remove blank line inside block-quote to satisfy markdownlint (MD028)

A blank line (Line 1053) splits the [!NOTE] and [!INFO] blocks, triggering MD028: no-blanks-blockquote.
You can simply drop the blank line:

 > [!NOTE]
 > Please note that LCS service will be run in a container. Llama Stack itself can be run in a container, in separate local process, or on external machine. It is just needed to know the URL (including TCP port) to connect to Llama Stack.
- 
 > [!INFO]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> [!NOTE]
> Please note that LCS service will be run in a container. Llama Stack itself can be run in a container, in separate local process, or on external machine. It is just needed to know the URL (including TCP port) to connect to Llama Stack.
[!NOTE]
If Llama Stack is started from a container or is running on separate machine, you can skip next parts - it is expected that everything is setup accordingly.
> [!INFO]
> If Llama Stack is started from a container or is running on separate machine, you can skip next parts - it is expected that everything is setup accordingly.
> [!NOTE]
> Please note that LCS service will be run in a container. Llama Stack itself can be run in a container, in separate local process, or on external machine. It is just needed to know the URL (including TCP port) to connect to Llama Stack.
> [!INFO]
> If Llama Stack is started from a container or is running on separate machine, you can skip next parts - it is expected that everything is setup accordingly.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

1053-1053: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🤖 Prompt for AI Agents 
In docs/getting_started.md around lines 1051 to 1055, there is a blank line
between the [!NOTE] and [!INFO] block quotes that violates markdownlint rule
MD028. Remove the blank line at line 1053 so that the two block quotes are
directly adjacent without any empty lines separating them.




Expand Down Expand Up @@ -1528,8 +1528,8 @@ Now it is needed to run *Lightspeed Core Stack* from within a container. The ser
podman run -it --network host -v lightspeed-stack.yaml:/app-root/lightspeed-stack.yaml:Z quay.io/lightspeed-core/lightspeed-stack:dev-latest
```

[!NOTE]
Please note that `--network host` is insecure option. It is used there because LCS service running in a container have to access Llama Stack running *outside* this container and the standard port mapping can not be leveraged there. This configuration would be ok for development purposes, but for real deployment, network needs to be reconfigured accordingly to maintain required container isolation!
> [!NOTE]
> Please note that `--network host` is insecure option. It is used there because LCS service running in a container have to access Llama Stack running *outside* this container and the standard port mapping can not be leveraged there. This configuration would be ok for development purposes, but for real deployment, network needs to be reconfigured accordingly to maintain required container isolation!



Expand Down
Loading