docs: Update quickstart page to structure things a little more for the novices #1873

franciscojavierarceo · 2025-04-04T21:17:57Z

What does this PR do?

Another doc enhancement for #1818

Summary of changes:

docs/source/distributions/configuration.md
- Updated dropdown title to include a more user-friendly description.
docs/_static/css/my_theme.css
- Added styling for <h3> elements to set a normal font weight.
docs/source/distributions/starting_llama_stack_server.md
- Changed section headers from bold text to proper markdown headers (e.g., ##).
- Improved descriptions for starting Llama Stack server using different methods (library, container, conda, Kubernetes).
- Enhanced clarity and structure by converting instructions into markdown headers and improved formatting.
docs/source/getting_started/index.md
- Major restructuring of the "Quick Start" guide:
  - Added new introductory section for Llama Stack and its capabilities.
  - Reorganized steps into clearer subsections with proper markdown headers.
  - Replaced dropdowns with tabbed content for OS-specific instructions.
  - Added detailed steps for setting up and running the Llama Stack server and client.
  - Introduced new sections for running basic inference and building agents.
  - Enhanced readability and visual structure with emojis, admonitions, and examples.
docs/source/providers/index.md
- Updated the list of LLM inference providers to include "Ollama."
- Expanded the list of vector databases to include "SQLite-Vec."

Let me know if you need further details!

Test Plan

Renders locally, included screenshot.

Documentation

For #1818

raghotham

the documentation changes look good. but this PR is changing many more files - is that intentional?

franciscojavierarceo · 2025-04-04T23:33:11Z

the documentation changes look good. but this PR is changing many more files - is that intentional?

No, I'll fix this, something went wrong when I made a new branch. Will be cleaned up later this evening. Sorry about that.

Update: All cleaned up now!

Signed-off-by: Francisco Javier Arceo <[email protected]>

franciscojavierarceo · 2025-04-07T03:23:04Z

@raghotham I incorporated the latest changes and fixed the conflicts. Still gives the same structure (i.e., making a install and setup at the beginning).

Signed-off-by: Francisco Javier Arceo <[email protected]>

docs/source/getting_started/index.md

Signed-off-by: Francisco Javier Arceo <[email protected]>

franciscojavierarceo · 2025-04-08T03:49:24Z

@raghotham updated 👍

I'll open the other PR after this is closed to show the smaller demo for getting started.

docs/source/getting_started/index.md

Signed-off-by: Francisco Javier Arceo <[email protected]>

docs/source/getting_started/index.md

Signed-off-by: Francisco Javier Arceo <[email protected]>

…ven shorter quickstart to highlight value in as few lines of code as possible Signed-off-by: Francisco Javier Arceo <[email protected]>

Signed-off-by: Francisco Javier Arceo <[email protected]>

raghotham · 2025-04-10T10:45:29Z

docs/_static/css/my_theme.css

@@ -16,3 +16,7 @@
 .hide-title h1 {
    display: none;
 }
+
+h3 {


Should it be h2 instead of h3?

raghotham · 2025-04-10T10:46:53Z

docs/source/getting_started/detailed_tutorial.md

+Llama Stack config for Ollama.
+::::{tab-set}
+
+:::{tab-item} Using Python


should add conda as well

raghotham · 2025-04-10T10:47:24Z

docs/source/getting_started/detailed_tutorial.md

+
+First lets setup some environment variables and create a local directory to mount into the container’s file system.
+```bash
+export INFERENCE_MODEL="meta-llama/Llama-3.2-3B-Instruct"


inference model can be the same as the one used above - we dont need to introduce new names to the same models.

raghotham · 2025-04-10T10:48:45Z

docs/source/getting_started/detailed_tutorial.md

+You can reuse the server setup or use the [Llama Stack Client](https://github.com/meta-llama/llama-stack-client-python/).
+Note that the client package is already included in the `llama-stack` package.
+
+### ii. Using the Llama Stack Client


there is no ### i.

raghotham · 2025-04-10T10:50:00Z

docs/source/getting_started/detailed_tutorial.md

+
+```
+
+## Step 4: Run Basic Inference


the rest of the "steps" are just different examples.

raghotham · 2025-04-10T10:52:33Z

docs/source/getting_started/index.md

 source .venv/bin/activate
+export INFERENCE_MODEL="llama3.2:3b"


why have the env var here?

raghotham · 2025-04-10T10:53:00Z

docs/source/getting_started/index.md

-from llama_stack_client import LlamaStackClient
-from llama_stack_client import Agent, AgentEventLogger
+from termcolor import cprint
+from llama_stack.distribution.library_client import LlamaStackAsLibraryClient


we dont want library as client - let's use server please.

raghotham · 2025-04-10T10:54:06Z

docs/source/getting_started/index.md

-]
+vector_db = "faiss"
+vector_db_id = "test-vector-db"
+model_id = "llama3.2:3b-instruct-fp16"


wrong model id - it should be llama3.2:3b

raghotham · 2025-04-10T10:54:40Z

docs/source/getting_started/index.md

+client.vector_dbs.register(
+    provider_id=vector_db,
+    vector_db_id=vector_db_id,
+    embedding_model="all-MiniLM-L6-v2",


embedding model showed up here - can we retrieve it from the distro server?

docs/source/getting_started/index.md

raghotham · 2025-04-10T21:08:48Z

will make minor fixes after merging this PR

franciscojavierarceo requested review from ashwinb, yanxi0830, hardikjshah, dltn, raghotham, dineshyv, vladimirivic, sixianyi0721, ehhuang, terrytangyuan, SLR722 and leseb as code owners April 4, 2025 21:17

facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 4, 2025

franciscojavierarceo changed the title ~~Docs 4~~ docs: Update quickstart page to structure things a little more for the novices Apr 4, 2025

franciscojavierarceo mentioned this pull request Apr 4, 2025

docs: Simplify getting started doc #1839

Open

raghotham requested changes Apr 4, 2025

View reviewed changes

franciscojavierarceo force-pushed the docs-4 branch 2 times, most recently from 2504e59 to e9d0517 Compare April 5, 2025 01:26

franciscojavierarceo added 4 commits April 6, 2025 21:44

make click more obvious

f2b0c28

Signed-off-by: Francisco Javier Arceo <[email protected]>

rebased

1639fd8

Signed-off-by: Francisco Javier Arceo <[email protected]>

updated providers index page and some copy on getting started

f822c58

Signed-off-by: Francisco Javier Arceo <[email protected]>

merged latest changes

11b53ac

Signed-off-by: Francisco Javier Arceo <[email protected]>

franciscojavierarceo force-pushed the docs-4 branch from 588ae97 to 11b53ac Compare April 7, 2025 03:21

franciscojavierarceo added 2 commits April 7, 2025 09:02

some more minor changes

b0ed138

Signed-off-by: Francisco Javier Arceo <[email protected]>

Some small copy changes

5a75727

Signed-off-by: Francisco Javier Arceo <[email protected]>

franciscojavierarceo force-pushed the docs-4 branch from 1252213 to 5a75727 Compare April 7, 2025 16:40

raghotham reviewed Apr 7, 2025

View reviewed changes

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

adjusted based on latest feedback

a23e504

Signed-off-by: Francisco Javier Arceo <[email protected]>

franciscojavierarceo mentioned this pull request Apr 9, 2025

docs: Create minimal Quickstart and add End to End quickstart #1906

Closed

Bobbins228 suggested changes Apr 9, 2025

View reviewed changes

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

handle feedback from mark

c583bee

Signed-off-by: Francisco Javier Arceo <[email protected]>

Bobbins228 approved these changes Apr 9, 2025

View reviewed changes

franciscojavierarceo added 2 commits April 9, 2025 07:48

Merge branch 'main' into docs-4

3366937

making <h3> font lighter for better visibility and moving some copy

72cc19a

Signed-off-by: Francisco Javier Arceo <[email protected]>

raghotham reviewed Apr 9, 2025

View reviewed changes

docs/source/getting_started/index.md Outdated Show resolved Hide resolved

franciscojavierarceo added 5 commits April 9, 2025 13:14

change model

fba6336

Signed-off-by: Francisco Javier Arceo <[email protected]>

moved the existing quickstart page to detailed tutorial and made an e…

662483f

…ven shorter quickstart to highlight value in as few lines of code as possible Signed-off-by: Francisco Javier Arceo <[email protected]>

adding server example back in and restructuring steps

0961987

Signed-off-by: Francisco Javier Arceo <[email protected]>

added tabs for the tutorial output and rephrased thing based on feedback

5bdd767

Signed-off-by: Francisco Javier Arceo <[email protected]>

small copy change

5ffe6ce

Signed-off-by: Francisco Javier Arceo <[email protected]>

raghotham reviewed Apr 10, 2025

View reviewed changes

Merge branch 'main' into docs-4

d7c976c

raghotham approved these changes Apr 10, 2025

View reviewed changes

raghotham closed this Apr 10, 2025

raghotham reopened this Apr 10, 2025

raghotham merged commit 49955a0 into meta-llama:main Apr 10, 2025
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update quickstart page to structure things a little more for the novices #1873

docs: Update quickstart page to structure things a little more for the novices #1873

franciscojavierarceo commented Apr 4, 2025 •

edited

Loading

raghotham left a comment

franciscojavierarceo commented Apr 4, 2025 •

edited

Loading

franciscojavierarceo commented Apr 7, 2025

franciscojavierarceo commented Apr 8, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham Apr 10, 2025

raghotham commented Apr 10, 2025

		source .venv/bin/activate
		export INFERENCE_MODEL="llama3.2:3b"

docs: Update quickstart page to structure things a little more for the novices #1873

docs: Update quickstart page to structure things a little more for the novices #1873

Conversation

franciscojavierarceo commented Apr 4, 2025 • edited Loading

What does this PR do?

Test Plan

Documentation

raghotham left a comment

Choose a reason for hiding this comment

franciscojavierarceo commented Apr 4, 2025 • edited Loading

franciscojavierarceo commented Apr 7, 2025

franciscojavierarceo commented Apr 8, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raghotham commented Apr 10, 2025

franciscojavierarceo commented Apr 4, 2025 •

edited

Loading

franciscojavierarceo commented Apr 4, 2025 •

edited

Loading