Skip to content

docs(code): refactor A3S Code SDK docs — Node/Python tabs, new pages, slimmed reference#6

Merged
ZhiXiao-Lin merged 1 commit into
mainfrom
docs/code-sdk-examples-refactor
May 30, 2026
Merged

docs(code): refactor A3S Code SDK docs — Node/Python tabs, new pages, slimmed reference#6
ZhiXiao-Lin merged 1 commit into
mainfrom
docs/code-sdk-examples-refactor

Conversation

@ZhiXiao-Lin
Copy link
Copy Markdown
Contributor

Refactor the A3S Code documentation under apps/docs/content/docs/{en,cn}/code (both locales kept in sync).

What changed

  • Convert all example pages to Node.js + Python tabs (was TS-only), faithful to the verified SDK surface and shipped runnable sources
  • Add orchestration example page (parallel / pipeline / parallelResumable)
  • Add Verification and Cluster Extension Points reference pages (previously homeless topics)
  • Slim api-contract.mdx: cross-link pointers to topic pages, keep the CI smoke-test snippets (mirrors docs_api_contract_smoke.mjs)
  • Fill empty batch / skill-tool stubs; fix positional git() call to the options-object form
  • Register new pages in nav (meta.json)

API-accuracy fixes (verified against the binding source)

  • parallelResumable(specs, workflowId) argument order + required sessionStore
  • Python helpers are synchronous — dropped erroneous await (batch, memory, sessions, persistence)
  • Bumped stale v3.1.0 references to v3.4.0

Docs-only; no submodule pointer bump (the crates/code neutralization shipped separately as AI45Lab/Code#62).

… slimmed reference

- Convert all example pages to Node.js + Python tabs (was TS-only),
  faithful to the verified SDK surface and shipped runnable sources
- Add orchestration example page (parallel / pipeline / parallelResumable)
- Add Verification and Cluster Extension Points reference pages
- Slim api-contract.mdx: cross-link pointers to topic pages, keep the
  CI smoke-test snippets (mirrors docs_api_contract_smoke.mjs)
- Fill empty batch / skill-tool stubs; fix positional git() call
- Fix API inaccuracies: parallelResumable(specs, workflowId) + required
  sessionStore; Python helpers are synchronous (drop erroneous await)
- Bump stale v3.1.0 references to v3.4.0; register new pages in nav
- EN and CN locales kept in sync
@ZhiXiao-Lin ZhiXiao-Lin merged commit 31ca068 into main May 30, 2026
@ZhiXiao-Lin ZhiXiao-Lin deleted the docs/code-sdk-examples-refactor branch May 30, 2026 12:28
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.

1 participant