Skip to content

Conversation

@fern-support
Copy link
Contributor

Summary

This PR updates the documentation to include the new --deep flag for the fern generate command across all SDK quickstart guides and the CLI reference.

Changes

  • CLI Reference: Added documentation for the --deep flag, explaining that it enables deep generation mode and is recommended for the latest CLI version to ensure complete SDK generation
  • SDK Quickstarts: Updated all fern generate command examples to include the --deep flag across:
    • C# SDK
    • Go SDK
    • Java SDK
    • PHP SDK
    • Python SDK
    • Ruby SDK
    • Swift SDK
    • TypeScript SDK
    • Postman collection

Justification

The --deep flag is an important new CLI feature that ensures complete SDK generation with the latest version. By documenting this flag in the CLI reference and updating all quickstart examples to include it, we help users:

  1. Discover and understand the purpose of the --deep flag
  2. Follow best practices when generating SDKs
  3. Avoid potential issues from incomplete SDK generation

This documentation update aligns the examples with current CLI capabilities and recommended usage patterns.

Update all SDK quickstart guides and CLI reference to include the --deep flag
for fern generate commands. This flag enables deep generation mode and ensures
complete SDK generation with the latest CLI version.

Changes include:
- Added --deep flag documentation to CLI commands reference
- Updated all SDK quickstart examples (C#, Go, Java, PHP, Python, Ruby, Swift, TypeScript, Postman)
- Updated example output paths to reflect --deep flag usage
@github-actions
Copy link
Contributor

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