mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-10-04 04:04:14 +00:00
docs: fix broken links (#3647)
Some checks failed
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 1s
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 0s
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 1s
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Python Package Build Test / build (3.12) (push) Failing after 1s
Python Package Build Test / build (3.13) (push) Failing after 0s
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 3s
Vector IO Integration Tests / test-matrix (push) Failing after 4s
Unit Tests / unit-tests (3.12) (push) Failing after 3s
Unit Tests / unit-tests (3.13) (push) Failing after 3s
Test External API and Providers / test-external (venv) (push) Failing after 5s
API Conformance Tests / check-schema-compatibility (push) Successful in 9s
UI Tests / ui-tests (22) (push) Successful in 43s
Pre-commit / pre-commit (push) Successful in 2m0s
Some checks failed
SqlStore Integration Tests / test-postgres (3.12) (push) Failing after 1s
SqlStore Integration Tests / test-postgres (3.13) (push) Failing after 0s
Integration Auth Tests / test-matrix (oauth2_token) (push) Failing after 1s
Test External Providers Installed via Module / test-external-providers-from-module (venv) (push) Has been skipped
Python Package Build Test / build (3.12) (push) Failing after 1s
Python Package Build Test / build (3.13) (push) Failing after 0s
Integration Tests (Replay) / Integration Tests (, , , client=, ) (push) Failing after 3s
Vector IO Integration Tests / test-matrix (push) Failing after 4s
Unit Tests / unit-tests (3.12) (push) Failing after 3s
Unit Tests / unit-tests (3.13) (push) Failing after 3s
Test External API and Providers / test-external (venv) (push) Failing after 5s
API Conformance Tests / check-schema-compatibility (push) Successful in 9s
UI Tests / ui-tests (22) (push) Successful in 43s
Pre-commit / pre-commit (push) Successful in 2m0s
# What does this PR do? * Fixes numerous broken links in the new documentation ## Test Plan * Server builds
This commit is contained in:
parent
5adcf0e0cb
commit
267f658968
6 changed files with 8 additions and 11 deletions
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
|
@ -2,7 +2,7 @@ blank_issues_enabled: false
|
||||||
|
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Have you read the docs?
|
- name: Have you read the docs?
|
||||||
url: https://llamastack.github.io/latest/providers/external/index.html
|
url: https://llamastack.github.io/providers/external/index.html
|
||||||
about: Much help can be found in the docs
|
about: Much help can be found in the docs
|
||||||
- name: Start a discussion
|
- name: Start a discussion
|
||||||
url: https://github.com/llamastack/llama-stack/discussions/new/
|
url: https://github.com/llamastack/llama-stack/discussions/new/
|
||||||
|
|
|
@ -120,7 +120,7 @@ By reducing friction and complexity, Llama Stack empowers developers to focus on
|
||||||
|
|
||||||
### API Providers
|
### API Providers
|
||||||
Here is a list of the various API providers and available distributions that can help developers get started easily with Llama Stack.
|
Here is a list of the various API providers and available distributions that can help developers get started easily with Llama Stack.
|
||||||
Please checkout for [full list](https://llamastack.github.io/latest/providers/index.html)
|
Please checkout for [full list](https://llamastack.github.io/providers/index.html)
|
||||||
|
|
||||||
| API Provider Builder | Environments | Agents | Inference | VectorIO | Safety | Telemetry | Post Training | Eval | DatasetIO |
|
| API Provider Builder | Environments | Agents | Inference | VectorIO | Safety | Telemetry | Post Training | Eval | DatasetIO |
|
||||||
|:--------------------:|:------------:|:------:|:---------:|:--------:|:------:|:---------:|:-------------:|:----:|:--------:|
|
|:--------------------:|:------------:|:------:|:---------:|:--------:|:------:|:---------:|:-------------:|:----:|:--------:|
|
||||||
|
@ -151,7 +151,7 @@ Please checkout for [full list](https://llamastack.github.io/latest/providers/in
|
||||||
| NVIDIA NEMO | Hosted | | ✅ | ✅ | | | ✅ | ✅ | ✅ |
|
| NVIDIA NEMO | Hosted | | ✅ | ✅ | | | ✅ | ✅ | ✅ |
|
||||||
| NVIDIA | Hosted | | | | | | ✅ | ✅ | ✅ |
|
| NVIDIA | Hosted | | | | | | ✅ | ✅ | ✅ |
|
||||||
|
|
||||||
> **Note**: Additional providers are available through external packages. See [External Providers](https://llamastack.github.io/latest/providers/external/index.html) documentation.
|
> **Note**: Additional providers are available through external packages. See [External Providers](https://llamastack.github.io/providers/external/index.html) documentation.
|
||||||
|
|
||||||
### Distributions
|
### Distributions
|
||||||
|
|
||||||
|
|
|
@ -181,7 +181,7 @@ Once defined, simply pass the tool to the agent config. `Agent` will take care o
|
||||||
agent = Agent(client, ..., tools=[my_tool])
|
agent = Agent(client, ..., tools=[my_tool])
|
||||||
```
|
```
|
||||||
|
|
||||||
Refer to [llama-stack-apps](https://github.com/meta-llama/llama-stack-apps/blob/main/examples/agents/e2e_loop_with_client_tools.py) for an example of how to use client provided tools.
|
Refer to [llama-stack-apps](https://github.com/meta-llama/llama-stack-apps/) for an example of how to use client provided tools.
|
||||||
|
|
||||||
## Tool Invocation
|
## Tool Invocation
|
||||||
|
|
||||||
|
|
|
@ -131,4 +131,4 @@ graph TD
|
||||||
3. **Configure your providers** with API keys or local models
|
3. **Configure your providers** with API keys or local models
|
||||||
4. **Start building** with Llama Stack!
|
4. **Start building** with Llama Stack!
|
||||||
|
|
||||||
For help choosing or troubleshooting, check our [Getting Started Guide](/docs/getting_started/quickstart) or [Community Support](https://github.com/llama-stack/llama-stack/discussions).
|
For help choosing or troubleshooting, check our [Getting Started Guide](/docs/getting_started/quickstart) or [Community Support](https://github.com/llamastack/llama-stack/discussions).
|
||||||
|
|
|
@ -45,7 +45,7 @@ Llama Stack consists of a server (with multiple pluggable API providers) and Cli
|
||||||
|
|
||||||
## Quick Links
|
## Quick Links
|
||||||
|
|
||||||
- Ready to build? Check out the [Getting Started Guide](https://llama-stack.github.io/getting_started/quickstart) to get started.
|
- Ready to build? Check out the [Getting Started Guide](/docs/getting_started/quickstart) to get started.
|
||||||
- Want to contribute? See the [Contributing Guide](https://github.com/llamastack/llama-stack/blob/main/CONTRIBUTING.md).
|
- 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.
|
- Explore [Example Applications](https://github.com/llamastack/llama-stack-apps) built with Llama Stack.
|
||||||
|
|
||||||
|
@ -59,13 +59,13 @@ Llama Stack provides adapters for popular providers across all API categories:
|
||||||
- **Training & Evaluation**: HuggingFace, TorchTune, NVIDIA NEMO
|
- **Training & Evaluation**: HuggingFace, TorchTune, NVIDIA NEMO
|
||||||
|
|
||||||
:::info Provider Details
|
:::info Provider Details
|
||||||
For complete provider compatibility and setup instructions, see our [Providers Documentation](https://llamastack.github.io/providers/).
|
For complete provider compatibility and setup instructions, see our [Providers Documentation](https://llamastack.github.io/docs/providers/).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Get Started Today
|
## Get Started Today
|
||||||
|
|
||||||
<div style={{display: 'flex', gap: '1rem', flexWrap: 'wrap', margin: '2rem 0'}}>
|
<div style={{display: 'flex', gap: '1rem', flexWrap: 'wrap', margin: '2rem 0'}}>
|
||||||
<a href="https://llama-stack.github.io/getting_started/quickstart"
|
<a href="/docs/getting_started/quickstart"
|
||||||
style={{
|
style={{
|
||||||
background: 'var(--ifm-color-primary)',
|
background: 'var(--ifm-color-primary)',
|
||||||
color: 'white',
|
color: 'white',
|
||||||
|
|
|
@ -26,9 +26,6 @@ const config: Config = {
|
||||||
{
|
{
|
||||||
docs: {
|
docs: {
|
||||||
sidebarPath: require.resolve("./sidebars.ts"),
|
sidebarPath: require.resolve("./sidebars.ts"),
|
||||||
// Please change this to your repo.
|
|
||||||
// Remove this to remove the "edit this page" links.
|
|
||||||
editUrl: 'https://github.com/meta-llama/llama-stack/tree/main/docs/',
|
|
||||||
docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi
|
docItemComponent: "@theme/ApiItem", // Derived from docusaurus-theme-openapi
|
||||||
},
|
},
|
||||||
blog: false,
|
blog: false,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue