Skip to content

Add documentation for prefect sdk generate CLI#20241

Merged
desertaxle merged 7 commits intomainfrom
custom-deployments-sdk-docs
Jan 15, 2026
Merged

Add documentation for prefect sdk generate CLI#20241
desertaxle merged 7 commits intomainfrom
custom-deployments-sdk-docs

Conversation

@desertaxle
Copy link
Member

Summary

  • Add auto-generated CLI reference for prefect sdk command
  • Add comprehensive how-to guide for generating typed SDKs from deployments
  • Update navigation in docs.json for both new pages
  • Regenerate CLI docs to include new --output options

🤖 Generated with Claude Code

- Add auto-generated CLI reference for `prefect sdk` command
- Add how-to guide for generating typed SDKs from deployments
- Update navigation in docs.json for both new pages
- Regenerate CLI docs to include new --output options

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Keep only sdk.mdx from the CLI docs regeneration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The code examples reference a hypothetical my_sdk module that
doesn't exist, so they can't be executed as tests.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove marketing-style "before/after" section
- Use sentence case headers
- Task-oriented organization (CLI then Python)
- Add opening context and further reading links
- Direct, instructional tone throughout

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove marketing-style "before/after" section
- Use sentence case headers
- Task-oriented organization (CLI then Python)
- Add opening context and further reading links
- Direct, instructional tone throughout

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copy link
Collaborator

@chrisguidry chrisguidry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This turned out so nicely! Great docs

Copy link
Collaborator

@zzstoatzz zzstoatzz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hm i expected these docs to be in the advanced section. it feels like a lot of trouble for the average user to go through

- Move generate-custom-sdk.mdx to docs/v3/advanced/
- Create new "Deployments" group in Advanced section
- Move form-building guide to new Deployments group
- Both guides relate to deployment configuration

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@desertaxle
Copy link
Member Author

hm i expected these docs to be in the advanced section. it feels like a lot of trouble for the average user to go through

I moved it to "Advanced" and grouped it with the "Configure UI forms for validating workflow inputs" guide under a new "Deployments" heading.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants