Skip to content

docs(systemone): document API, limits, and metrics - #15425

Draft
biswapanda wants to merge 10 commits into
bis/systemone-examplesfrom
bis/systemone-docs
Draft

biswapanda wants to merge 10 commits into
bis/systemone-examplesfrom
bis/systemone-docs

Conversation

@biswapanda

@biswapanda biswapanda commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Stack entry 3 of 3, based on bis/systemone-examples; merge after the implementation and shell-example PRs.

Stack, in merge order: implementation #15424 → shell examples #15426 → this documentation PR.

  • Adds the System One API reference and navigation entry.
  • Documents enablement, backend/model restrictions, request/answer contracts, uncalibrated score semantics, probability rounding tolerance, error categories, limits, cancellation, placement, and cache isolation.
  • Updates frontend configuration, environment variables, backend compatibility, bounded metrics, and the SGLang shell workflow.
  • Distinguishes native /generate parity from upstream System One compatibility and retains experimental/disabled-by-default rollout guidance.
  • Documents strict SGLang 0.5.19 serialized compatibility, permanent admission failures versus temporary overload, four preprocessing jobs/four active siblings, 1,048,576 token-equivalents and 16 MiB of cumulative validation text, and the Bash 4.4 requirement.

Validation

  • Scoped repository hooks and whitespace checks passed for all nine changed documentation files.
  • Documentation lint: zero errors; five existing navigation warnings.
  • fern check: zero errors; three existing warnings.
  • fern docs broken-links: only the existing unrelated DeepSeek V4 Pro recipe link at deepseek-v4-pro-0813.mdx:254; no task-related broken links. The CLI reports that finding despite exiting zero.
  • Shell references were validated by the examples PR's actual local launch and smoke run.

Draft status follows the implementation's remaining release-evidence gates.

Real Qwen3.8-27B sequential validation passed; default mixed batching crashed the upstream SGLang 0.5.19 scheduler. The final guarded run with overlap disabled and capacity one observed 92 HTTP 200 responses and eight expected temporary HTTP 529 responses out of 100 first-attempt requests, without retries. The implementation enforces this serialized compatibility contract and isolates it in WorkerSet identity. Unrestricted mixed batching remains unsupported; final updated-bindings validation and broader release-evidence gates remain distinct.

Evidence correction

Part of #15961. Commit 4a5a6ff77d712fbe02f1f5664363c3e66815cfe5 corrects the historical load-test paragraph: 92 HTTP 200 responses (42 decision and 50 chat) and eight expected HTTP 529 responses from the preflight-capacity guard, without retries. This is a factual correction on the existing documentation branch, not a rebase or revival of the older implementation stack.

Scoped hooks, documentation lint and Fern check passed. The existing unrelated DeepSeek recipe broken link remains disclosed above. Current decision API delivery uses the newer D1–D7 stack beginning at #15849; this correction does not qualify newer runtime behavior.

Follow-up CI and link repairs

Signed follow-ups fix the sidebar API-block order, pin historical System One sources, add explicit frontend ownership for the historical examples, repair the approved GLM/vLLM/Miles links, and correct the DeepSeek recipe cross-reference. Final head: a56cbd27b6121c67ef968fa282915325352f0227. Historical recipes keep their original checkpoints and configuration; removed scripts and assets explicitly require their linked revision. No API implementation is revived or changed.

  • All verified external replacements returned HTTP 200; the official Miles project replaces the unavailable fork without adding a Dynamo compatibility claim.
  • Fern broken-links reports “All checks passed”; docs lint, catalog validation, Fern check and scoped hooks passed.
  • Ownership validation covers 5970/5970 files; 158 ownership tests passed. CODEOWNERS was regenerated from its source policy.
  • The preceding preview asset-registration failure passed on one unchanged retry. New-head remote CI is separately tracked and is not implied by local validation.

This legacy PR remains draft; current decision API implementation delivery is the D1–D7 stack beginning at #15849. Part of #15961.

Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
@github-actions

github-actions Bot commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
Signed-off-by: Biswa Panda <biswa.panda@gmail.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

✅ Dynamo PR CI passed — run 39493937100 (attempt 1) on a56cbd27b6

Gate checks: ✅ backend-status-check · ✅ deploy-status-check · ✅ dynamo-status-check

Posted automatically by Devin for run 39493937100. Updated on every full-CI run of this PR.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant