Add explicit docs for consuming OKP#1337
Add explicit docs for consuming OKP#1337bparees wants to merge 1 commit intolightspeed-core:mainfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdded a new documentation file Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
bparees
force-pushed
the
okp_docs
branch
2 times, most recently
from
539c7f0 to
1999c5b
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/okp_guide.md (1)
126-127: Unify provider path variable naming in commands and bullets.The doc mixes hardcoded path,
$PROVIDERS_DIR, andEXTERNAL_PROVIDERS_DIR. Use one variable name consistently to avoid setup mistakes.Also applies to: 132-132, 143-143
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 126 - 127, The doc mixes a hardcoded path ("../lightspeed-providers"), $PROVIDERS_DIR, and EXTERNAL_PROVIDERS_DIR; pick a single variable name (e.g. $PROVIDERS_DIR) and replace all occurrences in the commands and bullet points (including the shown uv pip install command and the other occurrences at the indicated ranges) so every example uses the same variable consistently; ensure the chosen variable is documented once at the top of the section so readers know what to set.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Around line 58-59: Remove any user-facing mention of the internal filter
"is_chunk:true" and update the chunk_filter_query examples and text so they
present chunk_filter_query as only an additive user-provided filter;
specifically, delete or reword the literal is_chunk:true in the
chunk_filter_query example and all other occurrences of "is_chunk:true" in the
document, and replace with wording that clarifies the system injects internal
chunk filtering (e.g., “an internal chunk filter is applied automatically”)
while showing only user-configurable filters for chunk_filter_query.
- Line 138: Update the heading "## Step 5: Setup llamamstack config environment
variables" to correct the typo and improve wording by changing "llamamstack" to
"Llama Stack" and optionally capitalizing "Setup" to "Set up" for clarity:
ensure the heading reads something like "## Step 5: Set up Llama Stack config
environment variables" so the phrase "Llama Stack" is used consistently and
grammar is correct.
- Around line 22-25: Update the table of contents entries so each link matches
the actual heading slugs and add the two missing target sections referenced by
the TOC; specifically ensure the headings "Step 4: Install Dependencies and
Launch Lightspeed Stack", "Step 5: Verify the Stack", "OKP Configuration
Reference", and "References" exist with exact text (or update the TOC to match
their current exact heading text/slug), and add any missing sections that were
referenced but not present (create corresponding headings and content
placeholders for the two absent targets). Verify anchors use the current
markdown slug format (lowercase, hyphenated) so links resolve correctly.
---
Nitpick comments:
In `@docs/okp_guide.md`:
- Around line 126-127: The doc mixes a hardcoded path
("../lightspeed-providers"), $PROVIDERS_DIR, and EXTERNAL_PROVIDERS_DIR; pick a
single variable name (e.g. $PROVIDERS_DIR) and replace all occurrences in the
commands and bullet points (including the shown uv pip install command and the
other occurrences at the indicated ranges) so every example uses the same
variable consistently; ensure the chosen variable is documented once at the top
of the section so readers know what to set.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c3ddbbe5-07e2-4647-b249-61161982f1bf
📒 Files selected for processing (1)
docs/okp_guide.md
docs/okp_guide.md
Outdated
| rerun the `uv pip install` command if you rerun `uv sync`. | ||
|
|
||
|
|
||
| ## Step 5: Setup llamamstack config environment variables |
There was a problem hiding this comment.
Fix heading typo: llamamstack → Llama Stack.
Small wording correction for clarity and consistency.
Suggested fix
-## Step 5: Setup llamamstack config environment variables
+## Step 5: Setup Llama Stack config environment variables📝 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.
| ## Step 5: Setup llamamstack config environment variables | |
| ## Step 5: Setup Llama Stack config environment variables |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/okp_guide.md` at line 138, Update the heading "## Step 5: Setup
llamamstack config environment variables" to correct the typo and improve
wording by changing "llamamstack" to "Llama Stack" and optionally capitalizing
"Setup" to "Set up" for clarity: ensure the heading reads something like "##
Step 5: Set up Llama Stack config environment variables" so the phrase "Llama
Stack" is used consistently and grammar is correct.
29ab48a to
7274622
Compare
|
@Anxhela21 @are-ces ptal |
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
docs/okp_guide.md (2)
71-71:⚠️ Potential issue | 🟡 MinorFix heading: use "Llama Stack" instead of "llamamstack".
For consistency with the rest of the document, use proper casing.
📝 Proposed fix
-## Step 2: Setup llamamstack config environment variables +## Step 2: Setup Llama Stack config environment variables🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 71, The heading "Step 2: Setup llamamstack config environment variables" uses the wrong casing; update that heading to read "Step 2: Setup Llama Stack config environment variables" (replace the token "llamamstack" with "Llama Stack") and scan nearby headings for similar casing inconsistencies to ensure consistency with other occurrences in the document.
113-113:⚠️ Potential issue | 🟠 MajorDo not document the internal
is_chunk:truefilter.This field is user-facing and should only show optional additive filters. The system always injects the internal chunk filter automatically.
🔒 Proposed fix
okp: offline: true - chunk_filter_query: "is_chunk:true" + chunk_filter_query: "" # Optional: add custom Solr filters hereBased on learnings, the internal
is_chunk:truefilter is always injected by the system and must not be mentioned in user-facing docs.Also applies to: 124-124, 129-129
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 113, Remove the internal-only filter from the user-facing docs by deleting any occurrences of the explicit "is_chunk:true" example value for the chunk_filter_query field and any other places where the internal filter is shown; update text/examples around the chunk_filter_query symbol to state that optional additive filters may be provided and clarify that the system automatically injects the internal chunk filter instead of showing "is_chunk:true" to users.
🧹 Nitpick comments (1)
docs/okp_guide.md (1)
44-44: Consider using consistent horizontal rule style.The document uses
---(3 hyphens) throughout, but this line has---(with a trailing space). For consistency, use---without trailing spaces.✨ Proposed fix
---- +---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 44, Replace the inconsistent horizontal rule text '--- ' with the standard '---' (remove the trailing space) in the docs/okp_guide.md entry so all horizontal rules are the same; look for the line containing the literal '--- ' and change it to '---' to ensure consistent style across the document.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Line 96: Fix the two typos in the sentence mentioning the commands "uv sync"
and "uv pip install": change "lightspeeed-providers" to "lightspeed-providers"
and "insatlled" to "installed" so the note reads that running `uv sync` will
remove the lightspeed-providers dependency installed by the `uv pip install`
command, and you will need to rerun `uv pip install` if you rerun `uv sync`.
- Around line 210-211: The numbered troubleshooting bullets referencing "You
started Lightspeed Stack with the **enriched** run file from Step 2" and
"`lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in
Step 1" are incorrect; locate those exact list items in docs/okp_guide.md and
update the step numbers (or replace "Step X" with the correct section
headings/anchors) so they match the actual sections where the enriched run file
and the lightspeed-stack.yaml okp configuration are described; ensure the
phrases remain unchanged except for the corrected step/section references.
---
Duplicate comments:
In `@docs/okp_guide.md`:
- Line 71: The heading "Step 2: Setup llamamstack config environment variables"
uses the wrong casing; update that heading to read "Step 2: Setup Llama Stack
config environment variables" (replace the token "llamamstack" with "Llama
Stack") and scan nearby headings for similar casing inconsistencies to ensure
consistency with other occurrences in the document.
- Line 113: Remove the internal-only filter from the user-facing docs by
deleting any occurrences of the explicit "is_chunk:true" example value for the
chunk_filter_query field and any other places where the internal filter is
shown; update text/examples around the chunk_filter_query symbol to state that
optional additive filters may be provided and clarify that the system
automatically injects the internal chunk filter instead of showing
"is_chunk:true" to users.
---
Nitpick comments:
In `@docs/okp_guide.md`:
- Line 44: Replace the inconsistent horizontal rule text '--- ' with the
standard '---' (remove the trailing space) in the docs/okp_guide.md entry so all
horizontal rules are the same; look for the line containing the literal '--- '
and change it to '---' to ensure consistent style across the document.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e5d929f2-43cc-4f02-861f-5324b7597a93
📒 Files selected for processing (1)
docs/okp_guide.md
bparees
force-pushed
the
okp_docs
branch
3 times, most recently
from
2ba322c to
9425057
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/okp_guide.md (3)
112-113:⚠️ Potential issue | 🟠 MajorDo not expose internal
is_chunk:truebehavior in user-facing config docs.
chunk_filter_queryis documented and exemplified as if users should setis_chunk:true; this leaks internal behavior and misrepresents the field semantics.Based on learnings, the internal `is_chunk:true` filter is always injected by the system and must not be mentioned in user-facing docs.📝 Proposed fix
okp: offline: true - chunk_filter_query: "is_chunk:true" + chunk_filter_query: "<optional additional Solr filter>" ... okp: offline: true - chunk_filter_query: "is_chunk:true" + chunk_filter_query: "<optional additional Solr filter>" ... -* **`okp.chunk_filter_query`**: Solr filter query applied to every OKP search (e.g. `"is_chunk:true"` to restrict to chunk documents). You can extend this with Solr boolean syntax such as `chunk_filter_query: "is_chunk:true AND product:*openshift*"` (see [RAG Guide - Query Filtering](rag_guide.md)). +* **`okp.chunk_filter_query`**: Optional additional Solr filter query applied to OKP searches. Use this to further narrow results with Solr boolean syntax (see [RAG Guide - Query Filtering](rag_guide.md)).Also applies to: 123-124, 128-128
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 112 - 113, Remove any user-facing examples or explanations that explicitly show or instruct setting chunk_filter_query to "is_chunk:true"; the system injects that filter internally so it must not be documented as a user-configurable value. Update the docs text and examples referencing chunk_filter_query (search for the token chunk_filter_query and any literal "is_chunk:true") to either show a neutral example without is_chunk or describe that the system will append internal chunk filters automatically; apply the same change to the other occurrences noted in the file.
214-215:⚠️ Potential issue | 🟡 MinorCorrect troubleshooting step references.
Line 214 and Line 215 reference Step 2/Step 1, but those actions are described later in the guide, which makes troubleshooting guidance misleading.
📝 Proposed fix
-2. You started Lightspeed Stack with the **enriched** run file from Step 2 -3. `lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in Step 1 +2. You started Lightspeed Stack with the **enriched** run file from Step 5 +3. `lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in Step 4🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 214 - 215, Update the two troubleshooting bullet points ("You started Lightspeed Stack with the **enriched** run file from Step 2" and "`lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in Step 1") so their step references point to the actual steps where those actions are described (or reorder the guide to place the described actions before this troubleshooting section); locate these exact lines and either change "Step 2"/"Step 1" to the correct step numbers that describe starting Lightspeed Stack with the enriched run file and configuring `lightspeed-stack.yaml`, or move the troubleshooting block after those steps. Ensure the updated references match the section headings used elsewhere in the guide so readers can navigate directly to the detailed instructions.
20-20:⚠️ Potential issue | 🟡 MinorFix Step 2 TOC anchor mismatch and naming typo.
Line 20 links to
#step-2-setup-llamamstack-config-environment-variables, but the actual heading at Line 70 slug is different, so the TOC link breaks.📝 Proposed fix
-* [Step 2: Setup llamamstack config environment variables](`#step-2-setup-llamamstack-config-environment-variables`) +* [Step 2: Set up Llama Stack config environment variables](`#step-2-set-up-llama-stack-config-environment-variables`) ... -## Step 2: Setup llamastack config environment variables +## Step 2: Set up Llama Stack config environment variablesAlso applies to: 70-70
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 20, The TOC entry "Step 2: Setup llamamstack config environment variables" has a typo and its anchor (`#step-2-setup-llamamstack-config-environment-variables`) doesn't match the actual heading slug; update the TOC link text and anchor to match the real heading slug (or vice versa) and fix the "llamamstack" typo to the correct name ("llamastack" or the project's canonical name) so the link resolves—ensure the TOC anchor string exactly matches the generated slug for the heading "Step 2: Setup ... config environment variables".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Line 140: Update the commented example URL string so the hostname is spelled
correctly: replace the occurrence of "http://lama-stack:87321" with
"http://llama-stack:87321" in the docs (look for the commented line "# url:
http://lama-stack:87321") to ensure consistent, copy/paste-safe examples.
---
Duplicate comments:
In `@docs/okp_guide.md`:
- Around line 112-113: Remove any user-facing examples or explanations that
explicitly show or instruct setting chunk_filter_query to "is_chunk:true"; the
system injects that filter internally so it must not be documented as a
user-configurable value. Update the docs text and examples referencing
chunk_filter_query (search for the token chunk_filter_query and any literal
"is_chunk:true") to either show a neutral example without is_chunk or describe
that the system will append internal chunk filters automatically; apply the same
change to the other occurrences noted in the file.
- Around line 214-215: Update the two troubleshooting bullet points ("You
started Lightspeed Stack with the **enriched** run file from Step 2" and
"`lightspeed-stack.yaml` has `okp` under `rag.inline` and/or `rag.tool` as in
Step 1") so their step references point to the actual steps where those actions
are described (or reorder the guide to place the described actions before this
troubleshooting section); locate these exact lines and either change "Step
2"/"Step 1" to the correct step numbers that describe starting Lightspeed Stack
with the enriched run file and configuring `lightspeed-stack.yaml`, or move the
troubleshooting block after those steps. Ensure the updated references match the
section headings used elsewhere in the guide so readers can navigate directly to
the detailed instructions.
- Line 20: The TOC entry "Step 2: Setup llamamstack config environment
variables" has a typo and its anchor
(`#step-2-setup-llamamstack-config-environment-variables`) doesn't match the
actual heading slug; update the TOC link text and anchor to match the real
heading slug (or vice versa) and fix the "llamamstack" typo to the correct name
("llamastack" or the project's canonical name) so the link resolves—ensure the
TOC anchor string exactly matches the generated slug for the heading "Step 2:
Setup ... config environment variables".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8e47b5b4-6594-4989-9b0c-e04997649b06
📒 Files selected for processing (1)
docs/okp_guide.md
| use_as_library_client: true | ||
| library_client_config_path: run_enriched_new.yaml | ||
| # Comment these lines out if present | ||
| # url: http://lama-stack:87321 |
There was a problem hiding this comment.
Fix hostname typo in commented example URL.
Line 140 uses lama-stack; this likely should be llama-stack for consistency and copy/paste safety.
📝 Proposed fix
- # url: http://lama-stack:87321
+ # url: http://llama-stack:87321📝 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.
| # url: http://lama-stack:87321 | |
| # url: http://llama-stack:87321 |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/okp_guide.md` at line 140, Update the commented example URL string so
the hostname is spelled correctly: replace the occurrence of
"http://lama-stack:87321" with "http://llama-stack:87321" in the docs (look for
the commented line "# url: http://lama-stack:87321") to ensure consistent,
copy/paste-safe examples.
docs/okp_guide.md
Outdated
|
|
||
| * **`rag.inline`** and **`rag.tool`**: Enable OKP as the RAG source for inline context injection and for the RAG tool. Tool rag means the LLM will be provided a search tool it can choose to invoke to find relevant content and augment the user prompt. The tool may or may not be invoked. Inline means a rag search and prompt augmentation will always occur. | ||
| * **`okp.offline`**: When `true`, source URLs use `parent_id` (offline/Mimir-style). When `false`, use `reference_url` (online). | ||
| * **`okp.chunk_filter_query`**: Solr filter query applied to every OKP search (e.g. `"is_chunk:true"` to restrict to chunk documents). You can extend this with Solr boolean syntax such as `chunk_filter_query: "is_chunk:true AND product:*openshift*"` (see [RAG Guide - Query Filtering](rag_guide.md)). |
docs/okp_guide.md
Outdated
| llama_stack: | ||
| ... | ||
| use_as_library_client: true | ||
| library_client_config_path: run_enriched_new.yaml |
There was a problem hiding this comment.
If you run the lightspeed-stack in library mode, the run.yaml will be enriched (see this PR and the enrichment script).
Basically the user does not need to touch the llama-stack config, they can just configure okp in the lightspeed-stack config (as you wrote above).
There was a problem hiding this comment.
@are-ces i'm not seeing how to control the solr url when using automatic enrichment? (not needed for how i'm doing this but curious in general how that's supposed to work, since it seems to just assume localhost:8983?)
There was a problem hiding this comment.
for now i added this note while removing all the explicit instructions to do enrichment:
> **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8983. If you need a different OKP url, you will need to run `uv run src/llama_stack_configuration.py -c lightspeed-stack.yaml -i run.yaml -o run_enriched.yaml` to generate the llamastack configuration, edit the `solr_url` value in that file, and then edit your lightspeed stack configuration to point to the enriched llamastack config file by setting `library_client_config_path: run_enriched.yaml`.
but if there is a better way, please let me know.
There was a problem hiding this comment.
Hey @bparees, this is how the solr url is configured:
solr_url_env = "${env.SOLR_URL:=http://localhost:8983/solr}"
The user can overwrite the default url by setting the SOLR_URL env variable.
Same goes for:
SOLR_COLLECTION
SOLR_VECTOR_FIELD
SOLR_CONTENT_FIELD
SOLR_EMBEDDING_MODEL
There was a problem hiding this comment.
great, i've moved the note up to the step about launching solr and clarified to set the env instead of generating and editing the enriched run.yaml.
|
|
||
| > **Note:** Remove `-d` to run in the foreground. | ||
|
|
||
| * The service listens on **port 8983** on the host (mapped from 8080 in the container). |
There was a problem hiding this comment.
As Jared mentioned, that's the port Solr runs on we might need a different one for our instance OKP
There was a problem hiding this comment.
these instructions are intended to be self-contained, they include instructions to run OKP on port 8983 (the podman command just above this).
If someone wants to run OKP elsewhere then likely a whole lot of things about these instructions would change (including the url itself)
docs/okp_guide.md
Outdated
| Or visit: **http://localhost:8983** | ||
|
|
||
| Ensure the LlamaStack `run_enriched_new.yaml` file is configured to use this OKP endpoint (the enrichment step typically adds the correct Solr/OKP URL; if you need a different host/port, adjust the `solr_url` config value accordingly). | ||
|
|
There was a problem hiding this comment.
I feel like the run_enriched_new.yaml file shouldn't be mentioned until the lightspeed-stack.yaml is first configured? WDYT?
There was a problem hiding this comment.
sounds like it may not be needed at all per @are-ces's comments above, but yes, I did some reordering of the steps and overlooked this item, good catch.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/okp_guide.md (2)
145-145:⚠️ Potential issue | 🟡 MinorCorrect hostname typo in the commented URL example.
Line 145 uses
lama-stackinstead ofllama-stack, which is error-prone for copy/paste.📝 Proposed fix
- # url: http://lama-stack:87321 + # url: http://llama-stack:87321🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 145, Update the commented URL example in docs/okp_guide.md to fix the hostname typo: change the string "http://lama-stack:87321" to "http://llama-stack:87321" so copy/paste uses the correct host; locate and edit the commented line containing the URL literal to replace "lama-stack" with "llama-stack".
20-25:⚠️ Potential issue | 🟡 MinorFix TOC anchors to match actual headings (and remove missing-step entry).
The TOC currently points to non-existent/mismatched sections (
Step 5: Run Configuration Enrichment,Step 7) and broken fragments, so navigation/lint checks fail.📝 Proposed TOC update
-* [Step 2: Setup llamamstack config environment variables](`#step-2-setup-llamamstack-config-environment-variables`) +* [Step 2: Setup llamastack config environment variables](`#step-2-setup-llamastack-config-environment-variables`) * [Step 3: Install Lightspeed Stack Dependencies](`#step-3-install-lightspeed-stack-dependencies`) * [Step 4: Configure Lightspeed Stack](`#step-4-configure-lightspeed-stack`) -* [Step 5: Run Configuration Enrichment](`#step-5-run-configuration-enrichment`) -* [Step 6: Launch Lightspeed Stack](`#step-6-launch-lightspeed-stack`) -* [Step 7: Verify the Stack](`#step-7-verify-the-stack`) +* [Step 5: Launch Lightspeed Stack](`#step-5-launch-lightspeed-stack`) +* [Step 6: Verify the Stack](`#step-6-verify-the-stack`)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 20 - 25, Update the table of contents so each anchor matches the exact heading text used below and remove any entries for non-existent steps: ensure entries like "Step 2: Setup llamamstack config environment variables", "Step 3: Install Lightspeed Stack Dependencies", "Step 4: Configure Lightspeed Stack", "Step 6: Launch Lightspeed Stack" use correct fragment identifiers that exactly match their headings (case and punctuation) and delete the incorrect/missing "Step 5: Run Configuration Enrichment" and "Step 7: Verify the Stack" lines; verify anchors correspond to heading slugs (or adjust headings to match TOC) so navigation and linting succeed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Line 38: Fix the duplicated word in the markdown list item that currently
reads "lightspeed-providers repository repository" by removing the extra
"repository" so the item reads "lightspeed-providers repository"; update the
list entry text (the markdown bullet containing "lightspeed-providers repository
repository") accordingly to remove the typo.
---
Duplicate comments:
In `@docs/okp_guide.md`:
- Line 145: Update the commented URL example in docs/okp_guide.md to fix the
hostname typo: change the string "http://lama-stack:87321" to
"http://llama-stack:87321" so copy/paste uses the correct host; locate and edit
the commented line containing the URL literal to replace "lama-stack" with
"llama-stack".
- Around line 20-25: Update the table of contents so each anchor matches the
exact heading text used below and remove any entries for non-existent steps:
ensure entries like "Step 2: Setup llamamstack config environment variables",
"Step 3: Install Lightspeed Stack Dependencies", "Step 4: Configure Lightspeed
Stack", "Step 6: Launch Lightspeed Stack" use correct fragment identifiers that
exactly match their headings (case and punctuation) and delete the
incorrect/missing "Step 5: Run Configuration Enrichment" and "Step 7: Verify the
Stack" lines; verify anchors correspond to heading slugs (or adjust headings to
match TOC) so navigation and linting succeed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d91fcbb3-b7db-4414-823c-92066816834c
📒 Files selected for processing (1)
docs/okp_guide.md
|
@are-ces @Anxhela21 thanks for the feedback, i think i've addressed all the items raised. The doc no longer directs users to run the enrichment script, though it does mention how to do so if needed to adjust the solr_url. It also doesn't by default direct them to specify a chunk_filter. I realize there is a lot of overlap between this and the rag_guide..I was looking to provide a streamlined "all i care about is getting lightspeed stack running with okp" guide so i still think there is value in having this, but you may feel differently over time as it needs maintenance updates. Up to you. |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/okp_guide.md (3)
145-145:⚠️ Potential issue | 🟡 MinorFix hostname typo in commented URL example.
Line 145 uses
lama-stack; this should bellama-stackto avoid copy/paste mistakes.📝 Suggested fix
- # url: http://lama-stack:87321 + # url: http://llama-stack:87321🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 145, Replace the incorrect hostname in the commented URL string "# url: http://lama-stack:87321" by changing "lama-stack" to "llama-stack" so the example reads "# url: http://llama-stack:87321"; update only the hostname in that commented URL occurrence to avoid copy/paste errors.
68-68:⚠️ Potential issue | 🟡 MinorStandardize product naming in Step 2 heading.
Line 68 uses “llamastack”; use “Llama Stack” for consistency with the rest of the docs and cleaner slug generation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` at line 68, Update the Step 2 heading text to use the standardized product name "Llama Stack" instead of "llamastack": change the heading line "## Step 2: Setup llamastack config environment variables" to "## Step 2: Setup Llama Stack config environment variables" and also update any generated slug or anchor derived from that heading (if present elsewhere in the file or site metadata) to match the new casing/spacing for consistency.
20-25:⚠️ Potential issue | 🟡 MinorFix broken TOC anchors and stale step labels.
Line 20 and Lines 23-25 don’t match existing section headings, so these links break navigation.
📝 Suggested TOC fix
-* [Step 2: Setup llamamstack config environment variables](`#step-2-setup-llamamstack-config-environment-variables`) +* [Step 2: Setup Llama Stack config environment variables](`#step-2-setup-llama-stack-config-environment-variables`) * [Step 3: Install Lightspeed Stack Dependencies](`#step-3-install-lightspeed-stack-dependencies`) * [Step 4: Configure Lightspeed Stack](`#step-4-configure-lightspeed-stack`) -* [Step 5: Run Configuration Enrichment](`#step-5-run-configuration-enrichment`) -* [Step 6: Launch Lightspeed Stack](`#step-6-launch-lightspeed-stack`) -* [Step 7: Verify the Stack](`#step-7-verify-the-stack`) +* [Step 5: Launch Lightspeed Stack](`#step-5-launch-lightspeed-stack`) +* [Step 6: Verify the Stack](`#step-6-verify-the-stack`)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 20 - 25, The table of contents entries "* [Step 2: Setup llamamstack config environment variables]*", "* [Step 3: Install Lightspeed Stack Dependencies]*", "* [Step 4: Configure Lightspeed Stack]*", "* [Step 5: Run Configuration Enrichment]*", "* [Step 6: Launch Lightspeed Stack]*" and "* [Step 7: Verify the Stack]*" have broken anchors/stale labels; update each TOC link text and its anchor target to exactly match the corresponding section headings in the document (fix typos like "llamamstack" to the correct heading text, and ensure anchor slugs match the headings' punctuation/case), so the bracketed link labels and the "#anchor" fragments point to the real section titles (adjust either the heading text or the TOC entries for consistency).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Line 6: Remove or update the stale sentence "Run the configuration enrichment
step" in the docs/okp_guide.md; replace it with wording that reflects the
current flow (e.g., mention that enrichment happens automatically later or point
to the automatic enrichment section) so the guide no longer references a
standalone "configuration enrichment step" that no longer exists.
---
Duplicate comments:
In `@docs/okp_guide.md`:
- Line 145: Replace the incorrect hostname in the commented URL string "# url:
http://lama-stack:87321" by changing "lama-stack" to "llama-stack" so the
example reads "# url: http://llama-stack:87321"; update only the hostname in
that commented URL occurrence to avoid copy/paste errors.
- Line 68: Update the Step 2 heading text to use the standardized product name
"Llama Stack" instead of "llamastack": change the heading line "## Step 2: Setup
llamastack config environment variables" to "## Step 2: Setup Llama Stack config
environment variables" and also update any generated slug or anchor derived from
that heading (if present elsewhere in the file or site metadata) to match the
new casing/spacing for consistency.
- Around line 20-25: The table of contents entries "* [Step 2: Setup llamamstack
config environment variables]*", "* [Step 3: Install Lightspeed Stack
Dependencies]*", "* [Step 4: Configure Lightspeed Stack]*", "* [Step 5: Run
Configuration Enrichment]*", "* [Step 6: Launch Lightspeed Stack]*" and "* [Step
7: Verify the Stack]*" have broken anchors/stale labels; update each TOC link
text and its anchor target to exactly match the corresponding section headings
in the document (fix typos like "llamamstack" to the correct heading text, and
ensure anchor slugs match the headings' punctuation/case), so the bracketed link
labels and the "#anchor" fragments point to the real section titles (adjust
either the heading text or the TOC entries for consistency).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e75a9c08-2d8c-429b-bc9d-0566054775a6
📒 Files selected for processing (1)
docs/okp_guide.md
bparees
force-pushed
the
okp_docs
branch
3 times, most recently
from
5eb33cc to
1a3fce6
Compare
|
I think it make sense to have a streamlined guide dedicated to OKP, it can be quite confusing to get it right when going through guides which include BYOK. I left a last comment above following our conversation. |
3 participants
Description
Adds a separate doc to walk users through running lightspeed stack with OKP rag enabled.
This doc assumes lightspeed stack is run in library mode, I intend to follow it up
with docs for running in server mode.
Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Summary by CodeRabbit