Skip to content

[Studio] Consolidate documentation and reproduction guide - #321

Merged
isLinXu merged 1 commit into
Tencent:mainfrom
9-71:studio/docs-reproduction
Oct 27, 2026
Merged

isLinXu merged 1 commit into
Tencent:mainfrom
9-71:studio/docs-reproduction

Conversation

@9-71

@9-71 9-71 commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Overview

Consolidate Studio documentation for setup, daily use, architecture, APIs, runtime behavior, security, and testing.

  • Add a quick start and user guide for submitting jobs, viewing logs, cancelling tasks, and downloading results.
  • Document service configuration, task lifecycle, persistence, artifacts, and checkpoint recovery.
  • Add API examples and the generated JobRequest JSON schema.
  • Update the root READMEs and F1 documentation links to the Studio guides.

Validation

  • Documentation review: 15 pages and 84 local links/anchors checked.
  • Python examples: 8 syntax checks passed.
  • Studio documentation: MkDocs strict build passed.
  • Codespell and git diff --check: passed.
  • Full-site validation identified pre-existing MkDocs configuration and Zensical YAML parsing issues, both reproduced on the unmodified baseline.

Related to #299

@isLinXu

isLinXu commented Oct 27, 2026

Copy link
Copy Markdown
Collaborator

LGTM

@isLinXu
isLinXu merged commit c73e537 into Tencent:main Oct 27, 2026
11 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants