LCORE-247: fixed notes in Getting started guide #334
Conversation
WalkthroughThis change standardizes the formatting of note and info blocks in the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 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 (
|
![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 (1)
docs/getting_started.md (1)
1531-1532: Minor wording polish (“cannot”, grammar)-> 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! +> Please note that `--network host` is an insecure option. It is used here because the LCS service running in a container has to access Llama Stack running *outside* this container and the standard port mapping cannot be leveraged. This configuration is acceptable for development purposes, but for real deployments the network must be configured properly to maintain container isolation.This resolves the LanguageTool style warning and tightens the sentence.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
1053-1053: Blank line inside blockquote
(MD028, no-blanks-blockquote)
🪛 LanguageTool
docs/getting_started.md
[style] ~1532-~1532: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...container and the standard port mapping can not be leveraged there. This configuration ...
(CAN_NOT_PREMIUM)
⏰ 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
🔇 Additional comments (3)
docs/getting_started.md (3)
94-95: Admonition converted to proper block-quote – looks good
The[!NOTE]block now renders correctly on GitHub and mkdocs-material.
105-106: Consistent formatting retained
Same improvement here; no further action needed.
992-993: Good call-out formatting
The container prerequisite note now follows the new style – all good.
| > [!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. |
There was a problem hiding this comment.
🛠️ 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.
| > [!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.
1 participant
Description
LCORE-247: fixed notes in Getting started guide
Type of change
Related Tickets & Documents
Summary by CodeRabbit