LCORE-248: Stub for Getting started guide

[tisnik]

Description

LCORE-248: Stub for Getting started guide

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

Summary by CodeRabbit

• Documentation
  • Added a comprehensive "Getting Started" guide covering deployment options, configuration examples, dependency setup, and usage instructions for the Llama Stack.
  • Included troubleshooting information for common installation errors.

[coderabbitai]

Walkthrough

A new "Getting started guide" has been introduced as a Markdown document. This guide covers deployment options, configuration examples, project setup, CLI usage, and error handling for the Llama Stack. No code or public entity declarations were changed; the update is documentation-only.

Changes

Cohort / File(s)	Change Summary
Getting Started Documentation docs/getting_started.md	Added a comprehensive guide detailing deployment, configuration, usage, and troubleshooting for Llama Stack.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

In docs a new guide hops in,
With YAML and CLI to begin.
Llama Stack’s path is now clear,
For new friends to draw near.
From config to launch, step by step,
Even errors get prepped!
📝🐇

✨ Finishing Touches

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/getting_started.md (2)

5-7: Remove placeholder TOC entry or add the matching section

The “Foobar” link points to a non-existent section, which triggers MD051 and breaks the generated table-of-contents.

-* [Foobar](#foobar)
+<!-- Placeholder removed – add a real section or delete the entry -->

---

198-239: Add language identifiers to all fenced code blocks

Three blocks (CLI help, command invocation, traceback) open with ``` but omit a language tag, violating MD040 and disabling syntax highlighting.

-```
+```text
 …
-```

-```
+```bash
 llama-stack-runner]$ uv run llama stack run
-```

-```
+```text
 Traceback (most recent call last):
   …
 AttributeError: 'Namespace' object has no attribute 'template'
-```

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 24fa36e and 4eb8f02.

⛔ Files ignored due to path filters (2)

• docs/llama_stack_as_library.svg is excluded by !**/*.svg
• docs/llama_stack_as_service.svg is excluded by !**/*.svg

📒 Files selected for processing (1)

• docs/getting_started.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/getting_started.md

5-5: Link fragments should be valid

(MD051, link-fragments)

---

198-198: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

223-223: Fenced code blocks should have a language specified

(MD040, fenced-code-language)