LCORE-247: Getting started guide: Usage section#333
LCORE-247: Getting started guide: Usage section#333tisnik merged 3 commits intolightspeed-core:mainfrom
Conversation
WalkthroughA new "Usage" section was added to the Changes
Sequence Diagram(s)Not applicable: Only documentation content was added. 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: 0
🧹 Nitpick comments (4)
docs/getting_started.md (4)
47-55: Fix list indentation to satisfy MD007 and improve readabilityThe nested list under “Usage” is indented with 4 spaces instead of the expected 2-space / 2-level pattern. This breaks consistent rendering in some Markdown renderers and is flagged by markdownlint.
-* [Usage](#usage) - * [Using OpenAPI Swagger UI](#using-openapi-swagger-ui) - * [Front page](#front-page) - * [Swagger UI](#swagger-ui) - * [Sending query to LLM](#sending-query-to-llm) - * [Using `curl`](#using-curl) - * [Accessing `info` REST API endpoint](#accessing-info-rest-api-endpoint) - * [Retrieving list of available models](#retrieving-list-of-available-models) - * [Retrieving LLM response](#retrieving-llm-response) +* [Usage](#usage) + * [Using OpenAPI Swagger UI](#using-openapi-swagger-ui) + * [Front page](#front-page) + * [Swagger UI](#swagger-ui) + * [Sending query to LLM](#sending-query-to-llm) + * [Using `curl`](#using-curl) + * [Accessing `info` REST API endpoint](#accessing-info-rest-api-endpoint) + * [Retrieving list of available models](#retrieving-list-of-available-models) + * [Retrieving LLM response](#retrieving-llm-response)
1697-1699: Convert bare URL to Markdown linkBare URLs trigger MD034 and can break line wrapping. Prefer angle brackets or link syntax.
-Open http://localhost:8080 URL in your web browser. The following front page should be displayed: +Open <http://localhost:8080> in your web browser. The following front page should be displayed:
1707-1708: Correct product name typo“Ligthspeed” → “Lightspeed”.
-... actual response from the Ligthspeed Core Stack service: +... actual response from the Lightspeed Core Stack service:
1855-1857: Fix spelling“containt” → “contain”.
-> As is shown on the previous example, the output might containt endlines, Markdown marks etc. +> As shown in the previous example, the output might contain new lines, Markdown markup, etc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
docs/screenshots/front_page.jpgis excluded by!**/*.jpgdocs/screenshots/info_endpoint.pngis excluded by!**/*.pngdocs/screenshots/openapi_swagger.pngis excluded by!**/*.pngdocs/screenshots/query_request.pngis excluded by!**/*.pngdocs/screenshots/query_response.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/getting_started.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
48-48: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
50-50: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
51-51: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
52-52: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
1697-1697: Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
docs/getting_started.md
[grammar] ~1707-~1707: Ensure spelling is correct
Context: .../info) and see actual response from the Ligthspeed Core Stack service: ![Swagger UI page]...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~1856-~1856: Ensure spelling is correct
Context: ... the previous example, the output might containt endlines, Markdown marks etc.
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (1)
docs/getting_started.md (1)
1703-1710: Duplicate screenshot referenceBoth the “Swagger UI” subsection and the “Sending query to LLM” subsection embed
openapi_swagger.png. If this is intentional, ignore; otherwise consider using distinct screenshots or omitting one to reduce noise.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/getting_started.md (4)
47-55: Fix list-indentation to satisfy markdownlint (MD007)
The new “Usage” TOC block uses 4/8-space indentation, while the rest of the document and MD007 expect 2/4. Aligning indentation avoids future linter noise.-* [Usage](#usage) - * [Using OpenAPI Swagger UI](#using-openapi-swagger-ui) - * [Front page](#front-page) - * [Swagger UI](#swagger-ui) - * [Sending query to LLM](#sending-query-to-llm) - * [Using `curl`](#using-curl) - * [Accessing `info` REST API endpoint](#accessing-info-rest-api-endpoint) - * [Retrieving list of available models](#retrieving-list-of-available-models) - * [Retrieving LLM response](#retrieving-llm-response) +* [Usage](#usage) + * [Using OpenAPI Swagger UI](#using-openapi-swagger-ui) + * [Front page](#front-page) + * [Swagger UI](#swagger-ui) + * [Sending query to LLM](#sending-query-to-llm) + * [Using `curl`](#using-curl) + * [Accessing `info` REST API endpoint](#accessing-info-rest-api-endpoint) + * [Retrieving list of available models](#retrieving-list-of-available-models) + * [Retrieving LLM response](#retrieving-llm-response)
1696-1721: Clarify screenshots & alt-text
The same image name (openapi_swagger.png) is reused three times (Lines 1705, 1716, 1720) with identical alt-text “Swagger UI page”, making it unclear which step each screenshot represents. Either capture distinct screenshots or reuse a single reference once and adjust surrounding wording.
Also consider a more descriptive alt-text (e.g. “/query request body example”) to improve accessibility.
1713-1716: Minor grammar – “sent”, not “send”-Some REST API endpoints like `/query` requires payload to be send into the service. +Some REST API endpoints, like `/query`, require a JSON payload to be sent to the service.
1833-1836: Minor grammar – “sent” & flow-To retrieve LLM response, the question (or query) needs to be send to inference model. Thus the `HTTP POST` method should be used: +To retrieve an LLM response, the question (or query) must be sent to the inference model; therefore, the `HTTP POST` method should be used:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/getting_started.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/getting_started.md
48-48: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
50-50: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
51-51: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
52-52: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
53-53: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
54-54: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
55-55: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
1 participant
Description
LCORE-247: Getting started guide: Usage section
Type of change
Related Tickets & Documents
Summary by CodeRabbit
curlcommands.