Skip to content

docs: comprehensive documentation overhaul and starter extra#5423

Merged
leseb merged 8 commits intollamastack:mainfrom
leseb:starter-extra
Apr 2, 2026
Merged

docs: comprehensive documentation overhaul and starter extra#5423
leseb merged 8 commits intollamastack:mainfrom
leseb:starter-extra

Conversation

@leseb
Copy link
Copy Markdown
Collaborator

@leseb leseb commented Apr 2, 2026

Summary

Major documentation cleanup and modernization across ~35 files, net -970 lines.

New features

  • [starter] pip extra in pyproject.toml enabling uvx --from 'llama-stack[starter]' llama stack run starter
  • InstallBlock component on landing page with Ollama/OpenAI tabs, syntax highlighting, and copy button
  • Lucide-style sidebar icons for provider sub-categories (Inference, Safety, Vector IO, etc.)

Content updates

  • Rewrite quickstart: uvx for experimenting, uv init for projects
  • Rewrite detailed tutorial: all examples use standard OpenAI SDK
  • Update all agents references to responses across distro configs and provider tables
  • Simplify concepts: architecture matches ARCHITECTURE.md, APIs page focuses on integration patterns
  • Rewrite Responses vs Agents page: Responses is primary, Agents is legacy
  • Clean up provider overview page
  • Fix broken tables, dead links, Sphinx toctree remnants

Removed

  • iOS/Android SDK pages (untested, unmaintained)
  • Post Training provider docs (API removed)
  • On-Device Distributions sidebar section
  • Duplicate content across quickstart/tutorial/starting-server pages

Test plan

  • cd docs && npm install && npx docusaurus build passes
  • Light and dark modes work
  • All sidebar links resolve
  • InstallBlock copy button works
  • API overview card links point to correct generated pages

🤖 Generated with Claude Code

leseb and others added 2 commits April 2, 2026 13:37
Add a `[starter]` optional dependency group to pyproject.toml that
bundles everything needed to run the starter distribution locally:
ollama, faiss-cpu, sentence-transformers, and pypdf.

This enables a zero-install experience via uvx:
  uvx --from 'llama-stack[starter]' llama stack run starter

Update the documentation landing page to show this command prominently
in the hero section, making the "time to first RAG" as short as possible.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
Rewrite quickstart with uvx one-liner and uv project setup paths.
Rewrite detailed tutorial using standard OpenAI SDK throughout.
Add InstallBlock component with language tabs (Ollama/OpenAI),
syntax-highlighted command, and copy button.

Update all references from Agents API to Responses API across
distribution configs, provider tables, and concept pages.
Remove Sphinx toctree syntax remnants from auto-generated pages.
Remove outdated iOS/Android SDK pages and post_training providers.
Fix broken API overview links, table formatting, and dead references.

Simplify concept pages: architecture now matches ARCHITECTURE.md,
APIs page focuses on how APIs work together instead of re-listing
endpoints, distributions page leads with starter distro.

Add Lucide-style sidebar icons for provider sub-categories.
Add [starter] pip extra to pyproject.toml for zero-install experience.
Restructure external providers to top-level sidebar position.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 2, 2026
@leseb
Copy link
Copy Markdown
Collaborator Author

leseb commented Apr 2, 2026

Screenshot 2026-04-02 at 15 19 23

The starter distribution initializes all providers at startup, so the
[starter] pip extra must include all their dependencies. Without the
full set, uvx --from 'llama-stack[starter]' crashes on missing imports.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Apr 2, 2026

This pull request has merge conflicts that must be resolved before it can be merged. @leseb please rebase it. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Apr 2, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@mergify mergify bot removed the needs-rebase label Apr 2, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
The provider_codegen.py used api_name.title() for page titles, which
produces underscored names like "Tool_Runtime" instead of "Tool Runtime".
Use the sidebar_label format (replace underscores, then title case) for
both the YAML title and the heading.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@leseb
Copy link
Copy Markdown
Collaborator Author

leseb commented Apr 2, 2026

uvx --from '.[starter]' llama stack run starter
INFO     2026-04-02T13:52:08.687685Z  llama_stack.cli.stack.run:108 Using stack configuration   category=cli
...
...

😏

leseb and others added 2 commits April 2, 2026 15:55
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Sébastien Han <seb@redhat.com>
@leseb leseb enabled auto-merge April 2, 2026 15:25
franciscojavierarceo pushed a commit that referenced this pull request Apr 2, 2026
…5424)

## Summary

Backport of the `[starter]` pip extra from #5423 to the release-0.7.x
branch.

Adds a `[starter]` optional dependency group to pyproject.toml that
bundles all
provider dependencies needed to run the starter distribution, enabling:

```bash
uvx --from 'llama-stack[starter]' llama stack run starter
```

## Dependencies

This PR depends on #5423 being merged to main first. The `[starter]`
extra
was validated there with CI and pre-commit checks.

## Test plan

- [ ] `uvx --from 'llama-stack[starter]' llama stack run starter` starts
successfully
- [ ] All starter providers initialize without import errors

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Sébastien Han <seb@redhat.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@leseb leseb added this pull request to the merge queue Apr 2, 2026
Merged via the queue into llamastack:main with commit 95fba5b Apr 2, 2026
89 checks passed
@leseb leseb deleted the starter-extra branch April 2, 2026 15:36
leseb added a commit to leseb/llama-stack that referenced this pull request Apr 2, 2026
…ack#5423)

## Summary

Major documentation cleanup and modernization across ~35 files, net -970
lines.

### New features
- **`[starter]` pip extra** in pyproject.toml enabling `uvx --from
'llama-stack[starter]' llama stack run starter`
- **InstallBlock component** on landing page with Ollama/OpenAI tabs,
syntax highlighting, and copy button
- **Lucide-style sidebar icons** for provider sub-categories (Inference,
Safety, Vector IO, etc.)

### Content updates
- Rewrite quickstart: `uvx` for experimenting, `uv init` for projects
- Rewrite detailed tutorial: all examples use standard OpenAI SDK
- Update all `agents` references to `responses` across distro configs
and provider tables
- Simplify concepts: architecture matches ARCHITECTURE.md, APIs page
focuses on integration patterns
- Rewrite Responses vs Agents page: Responses is primary, Agents is
legacy
- Clean up provider overview page
- Fix broken tables, dead links, Sphinx toctree remnants

### Removed
- iOS/Android SDK pages (untested, unmaintained)
- Post Training provider docs (API removed)
- On-Device Distributions sidebar section
- Duplicate content across quickstart/tutorial/starting-server pages

## Test plan

- [ ] `cd docs && npm install && npx docusaurus build` passes
- [ ] Light and dark modes work
- [ ] All sidebar links resolve
- [ ] InstallBlock copy button works
- [ ] API overview card links point to correct generated pages

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Signed-off-by: Sébastien Han <seb@redhat.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants