Skip to content

Conversation

@fern-support
Copy link
Contributor

Summary

This PR updates the documentation to include the --deep flag for all TypeScript SDK generation commands.

Changes

  • CLI Reference: Added documentation for the --deep flag, explaining that it enables deep generation mode recommended for TypeScript SDK generation
  • Code Examples: Updated all examples showing TypeScript SDK generation to include --deep flag:
    • CLI quickstart examples
    • GitHub Actions workflows
    • GitLab CI/CD pipelines
    • Publishing guides
  • Consistency: Improved formatting and alignment of code examples

Justification

The --deep flag is recommended for TypeScript SDK generation as it enables enhanced processing that benefits the generated output. By updating the documentation to consistently show this flag in all TypeScript SDK examples, we:

  1. Ensure users follow best practices from the start
  2. Provide consistent patterns across all documentation
  3. Reduce confusion about when and how to use the flag
  4. Align examples with recommended workflows

All examples now demonstrate the recommended approach for TypeScript SDK generation.

Update documentation and examples to include the --deep flag when generating
TypeScript SDKs. The --deep flag enables deep generation mode which is
recommended for TypeScript SDK generation and other generators that benefit
from enhanced processing.

Changes:
- Updated CLI reference to document the --deep flag
- Modified all TypeScript SDK generation examples to use --deep flag
- Updated GitHub Actions and GitLab CI/CD examples
- Improved code example formatting for consistency
@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