Skip to content

Conversation

@tisnik
Copy link
Contributor

@tisnik tisnik commented Oct 1, 2025

Description

LCORE-650: update Llama Stack version in documentation and examples

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement

Related Tickets & Documents

  • Related Issue #LCORE-650

Summary by CodeRabbit

  • Documentation

    • Updated all references to llama-stack to version 0.2.21 across getting started, deployment, and output/API examples.
    • Improved OpenAPI description formatting for clearer line breaks and refreshed example values.
    • Minor formatting cleanups to enhance readability; no behavioral or API changes.
  • Chores

    • Aligned example project configuration to depend on llama-stack 0.2.21 for consistency with documentation and examples.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 1, 2025

Walkthrough

Documentation and example references to llama-stack are updated from 0.2.20 to 0.2.21 across multiple files. docs/openapi.json also adjusts description formatting to use a literal newline and adds a trailing newline at EOF. No code logic, APIs, or control flow are changed.

Changes

Cohort / File(s) Summary
Version bump in docs and examples
README.md, docs/deployment_guide.md, docs/getting_started.md, docs/openapi.md, docs/output.md, examples/pyproject.llamastack.toml, src/models/responses.py
Update displayed/declared llama-stack version strings from 0.2.20 to 0.2.21 in examples, docs, and sample config.
OpenAPI description formatting
docs/openapi.json
Replace escaped newline with a literal newline in InfoResponse.description, update example llama_stack_version to 0.2.21, and add trailing newline at EOF.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • umago
  • matysek

Poem

I nibble notes and version strings—hop, hop, hooray!
From .20 to .21, the paths now point the way.
OpenAPI breathes a line, so neat and clean to see,
Docs refreshed, carrots fetched, all tidy as can be.
Thump-thump: shipped! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title directly references the ticket LCORE-650 and succinctly describes the primary update—bumping the Llama Stack version in documentation and examples—accurately reflecting the changes made without unnecessary detail or vagueness.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd96246 and 7ed7a6d.

📒 Files selected for processing (8)
  • README.md (1 hunks)
  • docs/deployment_guide.md (1 hunks)
  • docs/getting_started.md (2 hunks)
  • docs/openapi.json (2 hunks)
  • docs/openapi.md (1 hunks)
  • docs/output.md (1 hunks)
  • examples/pyproject.llamastack.toml (1 hunks)
  • src/models/responses.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
src/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

Use absolute imports for internal modules (e.g., from auth import get_auth_dependency)

Files:

  • src/models/responses.py
**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.py: All modules start with descriptive module-level docstrings explaining purpose
Use logger = logging.getLogger(name) for module logging after import logging
Define type aliases at module level for clarity
All functions require docstrings with brief descriptions
Provide complete type annotations for all function parameters and return types
Use typing_extensions.Self in model validators where appropriate
Use modern union syntax (str | int) and Optional[T] or T | None consistently
Function names use snake_case with descriptive, action-oriented prefixes (get_, validate_, check_)
Avoid in-place parameter modification; return new data structures instead of mutating arguments
Use appropriate logging levels: debug, info, warning, error with clear messages
All classes require descriptive docstrings explaining purpose
Class names use PascalCase with conventional suffixes (Configuration, Error/Exception, Resolver, Interface)
Abstract base classes should use abc.ABC and @AbstractMethod for interfaces
Provide complete type annotations for all class attributes
Follow Google Python docstring style for modules, classes, and functions, including Args, Returns, Raises, Attributes sections as needed

Files:

  • src/models/responses.py
src/{models/**/*.py,configuration.py}

📄 CodeRabbit inference engine (CLAUDE.md)

src/{models/**/*.py,configuration.py}: Use @field_validator and @model_validator for custom validation in Pydantic models
Use precise type hints in configuration (e.g., Optional[FilePath], PositiveInt, SecretStr)

Files:

  • src/models/responses.py
src/models/**/*.py

📄 CodeRabbit inference engine (CLAUDE.md)

src/models/**/*.py: Pydantic models: use BaseModel for data models and extend ConfigurationBase for configuration
Use @model_validator and @field_validator for Pydantic model validation

Files:

  • src/models/responses.py
🪛 Checkov (3.2.334)
docs/openapi.json

[high] 1-3162: Ensure that the global security field has rules defined

(CKV_OPENAPI_4)


[high] 1-3162: Ensure that security operations is not empty.

(CKV_OPENAPI_5)

⏰ 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

Comment on lines +393 to 395
"version": "0.2.21"
}
```
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Update remaining version example for consistency

Nice catch updating this sample to 0.2.21. There’s still another curl ... /v1/version output later in the guide (Line 1074) that shows 0.2.18, so readers get conflicting signals. Please bump that snippet to 0.2.21 as well.

🤖 Prompt for AI Agents
In docs/deployment_guide.md around lines 393-395 and again at ~1074, the example
curl /v1/version output is inconsistent (one shows "0.2.21" while the later
snippet still shows "0.2.18"); update the later snippet to match by changing the
version string to "0.2.21" so both examples are consistent; ensure the JSON
formatting and surrounding backticks remain unchanged.

@tisnik tisnik merged commit d47d139 into lightspeed-core:main Oct 1, 2025
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant