[Docs] Introduce CLI & API guide; rework the HTTP API reference page#3869
Merged
Conversation
peterschmidt85
force-pushed
the
docs/swagger-http-api-reference
branch
from
64b5d3b to
4451732
Compare
peterschmidt85
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves documentation for using
dstackthrough the CLI and HTTP API.The main change is a new CLI & API guide that covers project configuration, fleets, submitting and attaching to runs, logs, and basic HTTP API usage.
It also restructures the HTTP API reference into per-tag pages under
docs/reference/http/, keeps the OpenAPI schema available for client generation, and makes API tags lower-case in the server sources and generated docs.Related installation, quickstart, examples, service auth placeholders, and the
dstackskill were updated to use the same terminology and links.AI Assistance
This PR was prepared with AI assistance.