Skip to content

Commit 0f28c92

Browse files
[Docs] Add llms.txt and llms-full.txt (#3312)
* [Docs] Add llms.txt and llms-full.txt #3311 * [Docs] Add llms.txt and llms-full.txt #3311 Review fix
1 parent 40cb4a0 commit 0f28c92

File tree

3 files changed

+44
-3
lines changed

3 files changed

+44
-3
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: https://github.com/astral-sh/ruff-pre-commit
3-
rev: v0.11.6 # Should match pyproject.toml
3+
rev: v0.12.7 # Should match pyproject.toml
44
hooks:
55
- id: ruff
66
name: ruff common

mkdocs.yml

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ site_name: dstack
33
site_url: https://dstack.ai
44
site_author: dstack GmbH
55
site_description: >-
6-
dstack is an open-source AI container orchestration engine working with any cloud or data center.
6+
dstack is an open-source control plane for running development, training, and inference jobs on GPUs - across hyperscalers, neoclouds, or on-prem.
77
88
# Repository
99
repo_url: https://github.com/dstackai/dstack
@@ -60,6 +60,45 @@ theme:
6060

6161
# Plugins
6262
plugins:
63+
- llmstxt-md:
64+
sections:
65+
Getting started:
66+
- docs/index.md: What dstack is
67+
- docs/installation/index.md: How to set up the dstack server and the dstack CLI
68+
- docs/quickstart.md: How to get started and submit your first run
69+
Concepts:
70+
- docs/concepts/backends.md: How to configure backends - to connect dstack to cloud providers, Kubernetes clusters, etc
71+
- docs/concepts/fleets.md: How to create and manage fleets - required before submitting runs
72+
- docs/concepts/dev-environments.md: How to create dev environments - for interactive development using a desktop IDE
73+
- docs/concepts/tasks.md: How to run tasks - for training or fine-tuning, including distributed tasks
74+
- docs/concepts/services.md: How to deploy services - for model inference or web apps
75+
- docs/concepts/volumes.md: How to manage volumes - for persistent storage or caching
76+
- docs/concepts/secrets.md: How to manage secrets - for API keys or other sensitive data
77+
- docs/concepts/projects.md: How to manage projects - for managing separate teams
78+
- docs/concepts/gateways.md: How to manage gateways - enabling auto-scaling, rate limits, and custom domains
79+
Guides:
80+
- docs/guides/clusters.md: How to work with clusters - for distributed tasks
81+
- docs/guides/kubernetes.md: How to work with Kubernetes
82+
- docs/guides/server-deployment.md: Detailed guide on how to deploy the dstack server
83+
- docs/guides/troubleshooting.md: Common issues and how to troubleshoot them
84+
- docs/guides/metrics.md: How to monitor metrics
85+
- docs/guides/protips.md: Pro tips - tips and tricks to use dstack more efficiently
86+
Examples:
87+
- examples/single-node-training/trl/index.md: TRL
88+
- examples/single-node-training/axolotl/index.md: Axolotl
89+
- examples/distributed-training/trl/index.md: TRL
90+
- examples/distributed-training/axolotl/index.md: Axolotl
91+
- examples/distributed-training/ray-ragen/index.md: Ray+RAGEN
92+
- examples/clusters/nccl-tests/index.md: NCCL tests
93+
- examples/clusters/rccl-tests/index.md: RCCL tests
94+
- examples/inference/sglang/index.md: SGLang
95+
- examples/inference/vllm/index.md: vLLM
96+
- examples/inference/nim/index.md: NIM
97+
- examples/inference/trtllm/index.md: TensorRT-LLM
98+
Accelerators:
99+
- examples/accelerators/amd/index.md: AMD
100+
- examples/accelerators/tpu/index.md: TPU
101+
- examples/accelerators/tenstorrent/index.md: Tenstorrent
63102
- blog:
64103
blog_dir: blog
65104
post_url_format: "{slug}"
@@ -268,6 +307,7 @@ nav:
268307
- Plugins:
269308
- Python API: docs/reference/plugins/python/index.md
270309
- REST API: docs/reference/plugins/rest/index.md
310+
- llms-full.txt: https://dstack.ai/llms-full.txt
271311
- Examples:
272312
- examples.md
273313
- Single-node training:

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ dev = [
107107
"requests-mock>=1.12.1",
108108
"openai>=1.68.2",
109109
"freezegun>=1.5.1",
110-
"ruff==0.11.6", # should match .pre-commit-config.yaml
110+
"ruff==0.12.7", # should match .pre-commit-config.yaml
111111
"testcontainers>=4.9.2",
112112
"pytest-xdist>=3.6.1",
113113
"pyinstrument>=5.0.0",
@@ -124,6 +124,7 @@ dev = [
124124
"mkdocs-gen-files; python_version >= '3.11'",
125125
"mkdocstrings[python]; python_version >= '3.11'",
126126
"mkdocs-render-swagger-plugin; python_version >= '3.11'",
127+
"mkdocs-llmstxt-md; python_version >= '3.11'"
127128
]
128129

129130
[project.optional-dependencies]

0 commit comments

Comments
 (0)