ci: add SDK API reference sync workflows for TypeScript and Python#7943
Merged
ci: add SDK API reference sync workflows for TypeScript and Python#7943
Conversation
jwulf
added
8.9.0-alpha5
dx
jwulf
force-pushed
the
sdk-docs-ci
branch
3 times, most recently
from
0fc2653 to
f47eaca
Compare
This was referenced Feb 16, 2026
The landing page was inside the autogenerated directory, causing Docusaurus to render it as both the category link and a child item. Moving it to a sibling file (apis-tools/python-sdk.md) outside the autogenerated directory (apis-tools/python-sdk/) eliminates the duplicate sidebar entry.
- Replace monolithic python-sdk.md with split section pages (one per H2) - Update API reference docs from latest generator output - Replace sidebar.js module with _category_.json (autogenerated sidebar) - Update sidebars.js to use autogenerated dirName instead of require()
Move landing page from apis-tools/python-sdk/python-sdk.md to apis-tools/python-sdk.md (sibling of the autogenerated directory). Update sidebars.js link ID accordingly. Fix .gitignore to anchor python-sdk ignore to repo root. Regenerate docs with updated output.
megglos
approved these changes
Feb 27, 2026
Contributor
megglos
left a comment
megglos
left a comment
There was a problem hiding this comment.
approving to unblock as agree, let's review docs for each once you are done with your iterations
Contributor
|
🧹 Preview environment for this PR has been torn down. |
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
2 participants
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.
Description
This PR adds CI workflows and documentation for automatically syncing SDK API reference documentation into camunda-docs. This is the first of four PRs outlined in #7942.
What's included
.github/workflows/sync-ts-sdk-docs.yaml— Weekly sync workflow for TypeScript SDK API reference (TypeDoc → Markdown).github/workflows/sync-python-sdk-docs.yaml— Weekly sync workflow for Python SDK API reference (Sphinx → Markdown)howtos/sdk-api-reference.md— Documentation for maintainers on how the SDK doc sync workshowtos/setup.md— Note about dev server memory usage during large file regenerationsHow the sync works
PR plan (from #7942)
sidebars.js— Sidebar entries for the TypeScript and Python SDK API reference sections (next)When should this change go live?
PR Checklist
/docsdirectory (aka/next/).Ref #7942