LCORE-581: doc about the script #448
Conversation
WalkthroughREADME.md updated to document CORS settings (including defaults and allow_credentials), add RAG inference configuration examples, expand container image build/run instructions (server and library modes, verification), and introduce a docs-generation utility (scripts/gen_doc.py with make doc). Table of Contents adjusted accordingly. Changes
Sequence Diagram(s)Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (5)
README.md (5)
38-40: Fix TOC nesting for CORS → Default values/Allow credentials (MD007: ul-indent)."Allow credentials" should be a child of "CORS" and both child items should use 2-space-per-level indentation.
Apply this diff to the TOC:
- * [CORS](#cors) - * [Default values](#default-values) - * [Allow credentials](#allow-credentials) + * [CORS](#cors) + * [Default values](#default-values) + * [Allow credentials](#allow-credentials)Additionally, to keep the heading level consistent with the TOC nesting, update the section heading below (outside this hunk):
-## Allow credentials +### Allow credentials
42-42: Normalize TOC indent to 2 spaces per level (MD007).This item is a second-level entry under “RAG Configuration” and should use 2 spaces, not 4.
- * [Example configurations for inference](#example-configurations-for-inference) + * [Example configurations for inference](#example-configurations-for-inference)
46-49: Standardize TOC indentation for new “Building Container Images” subtree (MD007).Use 2 spaces for level-2 items and 4 spaces for level-3.
- * [Building Container Images](#building-container-images) - * [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode) - * [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode) - * [Verify it's running properly](#verify-its-running-properly) + * [Building Container Images](#building-container-images) + * [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode) + * [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode) + * [Verify it's running properly](#verify-its-running-properly)Note: Several pre-existing TOC entries also use 4/8-space indents; consider normalizing the entire TOC in a follow-up for consistency.
65-67: TOC consistency: indentation for the new “docs-generation” tool entries (MD007).Align to 2 spaces for level-2 and 4 spaces for level-3.
- * [Utility to generate documentation from source codes](#utility-to-generate-documentation-from-source-codes) - * [Path](#path-1) - * [Usage](#usage-2) + * [Utility to generate documentation from source codes](#utility-to-generate-documentation-from-source-codes) + * [Path](#path-1) + * [Usage](#usage-2)
747-760: Tighten wording and add a language tag to the fenced block (MD040).
- Grammar/wording: “source codes” → “source code”; “re-generate” → “regenerates”.
- Lint: add a language to the code fence containing “make doc”.
-## Utility to generate documentation from source codes +## Utility to generate documentation from source code -This script re-generate README.md files for all modules defined in Lightspeed Stack Service. +This script regenerates README.md files for all modules defined in the Lightspeed Stack service. -``` +```bash make doc</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro **💡 Knowledge Base configuration:** - MCP integration is disabled by default for public repositories - Jira integration is disabled by default for public repositories - Linear integration is disabled by default for public repositories You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 053d49fb6e19c63cd51e77816f7c7cb5907d0f93 and cda7507db85203f3bbfe7a969e78f2d735859505. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `README.md` (3 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>README.md</summary> 38-38: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 39-39: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 40-40: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 42-42: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 44-44: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 45-45: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 46-46: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 47-47: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 48-48: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 49-49: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 65-65: Unordered list indentation Expected: 2; Actual: 4 (MD007, ul-indent) --- 66-66: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 67-67: Unordered list indentation Expected: 4; Actual: 8 (MD007, ul-indent) --- 757-757: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>⏰ 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)</summary> * GitHub Check: build-pr * GitHub Check: e2e_tests </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
README.md (7)
38-41: Fix TOC nesting for CORS and “Allow credentials” (markdownlint MD007).“Allow credentials” should be a child of CORS and list indentation should use 2 spaces for nested bullets.
Apply this diff to normalize indentation and hierarchy:
-* [CORS](#cors) - * [Default values](#default-values) -* [Allow credentials](#allow-credentials) +* [CORS](#cors) + * [Default values](#default-values) + * [Allow credentials](#allow-credentials)Additionally, consider making the section header “Allow credentials” a subheading under CORS (see separate note below).
46-49: Normalize TOC indentation for “Building Container Images” subtree (markdownlint MD007).Use 2 spaces per nesting level; subitems under “Building Container Images” should be indented with 4 spaces total.
- * [Building Container Images](#building-container-images) - * [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode) - * [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode) - * [Verify it's running properly](#verify-its-running-properly) + * [Building Container Images](#building-container-images) + * [Llama-Stack as Separate Service (Server Mode)](#llama-stack-as-separate-service-server-mode) + * [Llama-Stack as Library (Library Mode)](#llama-stack-as-library-library-mode) + * [Verify it's running properly](#verify-its-running-properly)
65-67: Fix TOC text and indentation for the docs-generation utility (MD007, MD051).
- Indentation should be 2/4 spaces (not 4/8).
- The anchor text should match the section heading: “source code” (singular), not “source codes”.
- * [Utility to generate documentation from source codes](#utility-to-generate-documentation-from-source-codes) - * [Path](#path-1) - * [Usage](#usage-2) + * [Utility to generate documentation from source code](#utility-to-generate-documentation-from-source-code) + * [Path](#path-1) + * [Usage](#usage-2)
747-760: Polish the new docs-generation utility section and add language tag to the fenced code block (MD040).
- “re-generate” → “regenerates”.
- Add a language to the code fence.
-## Utility to generate documentation from source code - -This script re-generate README.md files for all modules defined in the Lightspeed Stack Service. +## Utility to generate documentation from source code + +This script regenerates README.md files for all modules defined in the Lightspeed Stack Service. @@ -### Usage - -``` -make doc -``` +### Usage + +```bash +make doc +```
549-572: Compose tool naming: mention Docker Compose alongside Podman Compose.The text references “docker-compose.yaml” but the commands use “podman compose”. Adding a brief note that users can run the same with “docker compose up --build” helps non-Podman users.
599-607: Nit: Capitalization — “macOS”.Change “For macosx users:” to “For macOS users:”. Keeps platform naming consistent elsewhere in the docs.
425-466: CORS doc clarity: align section level and add cross-link.Given the TOC nests “Allow credentials” under CORS, make the section header a subheading to match (i.e., “### Allow credentials”) and keep the reminder about wildcard origins. Also consider making the FastAPI link a markdown link.
Outside this hunk, update the header line from:
- “## Allow credentials”
to:- “### Allow credentials”
Optional link polish:
- “See the FastAPI CORS guide.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
38-38: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
39-39: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
42-42: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
44-44: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
45-45: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
46-46: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
47-47: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
48-48: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
49-49: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
65-65: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
65-65: Link fragments should be valid
(MD051, link-fragments)
66-66: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
67-67: Unordered list indentation
Expected: 4; Actual: 8
(MD007, ul-indent)
757-757: 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). (2)
- GitHub Check: build-pr
- GitHub Check: e2e_tests
🔇 Additional comments (1)
README.md (1)
747-760: Doc generator script and Makefile target verifiedAll checks passed—no further action needed:
- scripts/gen_doc.py exists at
scripts/gen_doc.py.- Makefile defines a
doc:target at line 46.- README.md includes the “## Utility to generate documentation from source code” section at line 747.
1 participant
Description
LCORE-581: doc about the script
Type of change
Related Tickets & Documents
Summary by CodeRabbit