Skip to content

SDK reference: display submodules in the sidebar#960

Merged
dobrac merged 15 commits intomainfrom
sdk-reference-submodules
Oct 16, 2025
Merged

SDK reference: display submodules in the sidebar#960
dobrac merged 15 commits intomainfrom
sdk-reference-submodules

Conversation

@mishushakov
Copy link
Copy Markdown
Member

@mishushakov mishushakov commented Oct 15, 2025

Screenshots:

JS SDK reference:
Screenshot 2025-10-15 at 18 16 30

Python SDK reference:
Screenshot 2025-10-15 at 18 16 36


Note

Show module headings and nested submodules in the SDK reference sidebar; add JS/Python Template docs (incl. logger/readycmd) and align exports for Typedoc.

  • Docs Web (apps/web/prebuild.js):
    • Sidebar now includes submodule anchors from each module page and appends nested modules with their own submodules.
    • Title formatting: _sync now rendered as " sync" (instead of removed) and _async as " async".
  • JS SDK Docs:
    • Add Typedoc entry points for template, template/readycmd, template/logger; exclude internal symbols in output.
    • Doc gen script moves logger and readycmd under template/ in output.
    • Public API: re-export everything from ./template; types moved to template/index.ts for unified exports.
  • Python SDK Docs:
    • Generate pages for template, template_sync, template_async and their logger/readycmd submodules (placed under both sync/async trees).
    • Script refactor with shared MDX processing.

Written by Cursor Bugbot for commit d407694. This will update automatically on new commits. Configure here.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Oct 15, 2025

⚠️ No Changeset found

Latest commit: d407694

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

cursor[bot]

This comment was marked as outdated.

@dobrac dobrac self-assigned this Oct 16, 2025
@dobrac dobrac requested review from dobrac and removed request for ValentaTomas, ben-fornefeld and jakubno October 16, 2025 08:38
cursor[bot]

This comment was marked as outdated.

cursor[bot]

This comment was marked as outdated.

@dobrac dobrac enabled auto-merge (squash) October 16, 2025 11:29
@dobrac dobrac merged commit 48acc02 into main Oct 16, 2025
8 checks passed
@dobrac dobrac deleted the sdk-reference-submodules branch October 16, 2025 11:32
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