phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-10-04 12:07:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: docusaurus setup (#3541)

Browse source 
# What does this PR do?

- Docusaurus server setup
- Deprecates Sphinx build pipeline
- Deprecates remaining references to Readthedocs
- MDX compile errors and broken links to be addressed in follow-up PRs

<!-- Provide a short summary of what this PR does and why. Link to relevant issues if applicable. -->

<!-- If resolving an issue, uncomment and update the line below -->

<!-- Closes #[issue-number] -->

## Test Plan

```
npm install
npm gen-api-docs all
npm run build
```

<!-- Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.* -->
This commit is contained in:
Alexey Rybak 2025-09-24 14:11:30 -07:00 • committed by GitHub
parent 610526d6d7
commit aebd728c81
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 23461 additions and 208 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/docs/contributing/index.mdx
View file

@ -187,14 +187,16 @@ Note that the provider "description" field will be used to generate the provider
### Building the Documentation
If you are making changes to the documentation at [https://llamastack.github.io/latest/](https://llamastack.github.io/latest/), you can use the following command to build the documentation and preview your changes. You will need [Sphinx](https://www.sphinx-doc.org/en/master/) and the readthedocs theme.
If you are making changes to the documentation at [https://llamastack.github.io/](https://llamastack.github.io/), you can use the following command to build the documentation and preview your changes.
```bash
# This rebuilds the documentation pages.
uv run --group docs make -C docs/ html
# This rebuilds the documentation pages and the OpenAPI spec.
npm install
npm run gen-api-docs all
npm run build
# This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes to the documentation.
uv run --group docs sphinx-autobuild docs/source docs/build/html --write-all
# This will start a local server (usually at http://127.0.0.1:3000).
npm run serve
```
### Update API Documentation
@ -205,7 +207,7 @@ If you modify or add new API endpoints, update the API documentation accordingly
uv run ./docs/openapi_generator/run_openapi_generator.sh
```
The generated API documentation will be available in `docs/_static/`. Make sure to review the changes before committing.
The generated API schema will be available in `docs/static/`. Make sure to review the changes before committing.
## Adding a New Provider

14
docs/docs/index.mdx
View file

@ -45,9 +45,9 @@ Llama Stack consists of a server (with multiple pluggable API providers) and Cli
## Quick Links
- Ready to build? Check out the [Getting Started Guide](https://llama-stack.readthedocs.io/en/latest/getting_started/index.html) to get started.
- Want to contribute? See the [Contributing Guide](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md).
- Explore [Example Applications](https://github.com/meta-llama/llama-stack-apps) built with Llama Stack.
- Ready to build? Check out the [Getting Started Guide](https://llama-stack.github.io/getting_started/quickstart) to get started.
- Want to contribute? See the [Contributing Guide](https://github.com/llamastack/llama-stack/blob/main/CONTRIBUTING.md).
- Explore [Example Applications](https://github.com/llamastack/llama-stack-apps) built with Llama Stack.
## Rich Ecosystem Support
@ -59,13 +59,13 @@ Llama Stack provides adapters for popular providers across all API categories:
- **Training & Evaluation**: HuggingFace, TorchTune, NVIDIA NEMO
:::info Provider Details
For complete provider compatibility and setup instructions, see our [Providers Documentation](https://llama-stack.readthedocs.io/en/latest/providers/index.html).
For complete provider compatibility and setup instructions, see our [Providers Documentation](https://llamastack.github.io/providers/).
:::
## Get Started Today
<div style={{display: 'flex', gap: '1rem', flexWrap: 'wrap', margin: '2rem 0'}}>
<a href="https://llama-stack.readthedocs.io/en/latest/getting_started/index.html"
<a href="https://llama-stack.github.io/getting_started/quickstart"
style={{
background: 'var(--ifm-color-primary)',
color: 'white',
@ -76,7 +76,7 @@ For complete provider compatibility and setup instructions, see our [Providers D
}}>
🚀 Quick Start Guide
</a>
<a href="https://github.com/meta-llama/llama-stack-apps"
<a href="https://github.com/llamastack/llama-stack-apps"
style={{
border: '2px solid var(--ifm-color-primary)',
color: 'var(--ifm-color-primary)',
@ -87,7 +87,7 @@ For complete provider compatibility and setup instructions, see our [Providers D
}}>
📚 Example Apps
</a>
<a href="https://github.com/meta-llama/llama-stack"
<a href="https://github.com/llamastack/llama-stack"
style={{
border: '2px solid #666',
color: '#666',