LCORE-695: updated doc

[tisnik]

Description

LCORE-695: updated doc

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-695

Summary by CodeRabbit

• Documentation

  • Updated installation, deployment, and getting-started guides to reference llama-stack 0.2.22.
  • Refreshed OpenAPI docs and example responses to show the new version and minor formatting fixes.

• Chores

  • Bumped example project dependency and documentation examples to llama-stack 0.2.22.

[coderabbitai]

Walkthrough

Bumps referenced llama-stack version from 0.2.21 to 0.2.22 across README, docs, examples, OpenAPI artifacts, and model example metadata. Also cleans up newline/formatting in docs/openapi.json. No functional code or control-flow changes.

Changes

Cohort / File(s)	Summary of changes
Docs & README README.md, docs/deployment_guide.md, docs/getting_started.md, docs/openapi.md, docs/output.md	Updated displayed and pinned llama-stack version strings from 0.2.21 to 0.2.22 in examples and snippets.
OpenAPI spec docs/openapi.json	Added 0.2.22 to allowed llama_stack_version values; updated example value and description newline formatting; ensured trailing newline.
Example project config examples/pyproject.llamastack.toml	Bumped dependency pin to llama-stack==0.2.22.
Model metadata examples src/models/responses.py	Expanded InfoResponse.llama_stack_version examples to include 0.2.21 and 0.2.22; updated example instantiation to llama_stack_version="0.2.22". No API/signature changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LCORE-650: update Llama Stack version in documentation and examples #607 — Performs the same kind of llama-stack version-string updates across docs and InfoResponse examples.
• LCORE-650: Support Llama Stack version 0.2.21 #606 — Prior sequential version-bump PR touching the same version fields and documentation.
• LCORE-633: updated documentation #524 — Documentation-only version-bump affecting the InfoResponse.llama_stack_version example.

Suggested reviewers

• umago

Poem

I twitch my whiskers: v0.2.22!
Hops through docs with joyful spree.
TOML crumbs and README gleam,
OpenAPI dreams a newline stream.
No code to burrow—just version tea. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The pull request title is too generic and does not summarize the main change, which is bumping the llama-stack dependency version to 0.2.22 across documentation and examples.	Rename the title to something more descriptive such as “Bump llama-stack version to 0.2.22 in documentation and examples” to clearly reflect the key change.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
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

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 101e4f3 and 742638a.

📒 Files selected for processing (8)

• README.md (1 hunks)
• docs/deployment_guide.md (3 hunks)
• docs/getting_started.md (1 hunks)
• docs/openapi.json (3 hunks)
• docs/openapi.md (1 hunks)
• docs/output.md (1 hunks)
• examples/pyproject.llamastack.toml (1 hunks)
• src/models/responses.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (4)

• docs/output.md
• src/models/responses.py
• docs/deployment_guide.md
• examples/pyproject.llamastack.toml

🧰 Additional context used

🪛 Checkov (3.2.334)

docs/openapi.json

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

(CKV_OPENAPI_4)

---

[high] 1-3163: 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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4978e6a and 101e4f3.

📒 Files selected for processing (8)

• README.md (1 hunks)
• docs/deployment_guide.md (3 hunks)
• docs/getting_started.md (1 hunks)
• docs/openapi.json (3 hunks)
• docs/openapi.md (1 hunks)
• docs/output.md (1 hunks)
• examples/pyproject.llamastack.toml (1 hunks)
• src/models/responses.py (2 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

🪛 Biome (2.1.2)

docs/openapi.json

[error] 2146-2146: expected , but instead found "0.2.22"

Remove "0.2.22"

(parse)

🪛 GitHub Actions: Integration tests

docs/openapi.json

[error] 2146-2146: JSONDecodeError: Expecting ',' delimiter at line 2146 column 29 while loading OpenAPI specification used by tests (OpenAPI JSON is malformed).

⏰ 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 (7)

src/models/responses.py (1)

167-167: LGTM!

The constructor example correctly reflects the updated llama-stack version 0.2.22.

README.md (1)

248-248: LGTM!

The example dependency version is correctly updated to 0.2.22, consistent with the PR's version bump.

docs/getting_started.md (1)

27-27: LGTM!

The installation command correctly reflects the updated llama-stack version 0.2.22.

docs/output.md (1)

1042-1042: LGTM!

The InfoResponse example correctly reflects the updated llama-stack version 0.2.22.

examples/pyproject.llamastack.toml (1)

7-7: LGTM!

The example dependency version is correctly updated to 0.2.22, consistent with the PR's version bump.

docs/openapi.md (1)

1042-1042: LGTM!

The InfoResponse example correctly reflects the updated llama-stack version 0.2.22.

docs/deployment_guide.md (1)

393-393: LGTM!

All documentation examples correctly reflect the updated llama-stack version 0.2.22.

Also applies to: 679-679, 1074-1074