Add 'fern deep' command to CLI reference #1510
Closed
+240
−5
Conversation
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
This commit introduces a new CLI command 'fern deep' that allows users to send emails directly to Deep, one of Fern's co-founders. The command includes options for customizing the message and subject line, making it easy for users to provide feedback, ask questions, or share ideas with the team.
Changed the CLI command syntax to use the flag format 'fern --dsinghvi' instead of the subcommand format 'fern deep'. Updated all references throughout the documentation including the command table, accordion title, usage examples, and code snippets.
Added documentation for the 'fern --dsheridan' flag that allows users to send emails directly to Danny, one of Fern's co-founders. This follows the same pattern as the existing --dsinghvi flag and includes: - Command entry in the main commands table - Complete accordion section with command syntax - --message and --subject options documentation - Multiple usage examples - Helpful tip encouraging community engagement
Enhanced both co-founder email commands with the --respond_to option to allow users to provide their email address for responses. This update includes: - Added --respond_to parameter to command syntax for both flags - New documentation section explaining the --respond_to option - Updated all usage examples to demonstrate the --respond_to option - Improved example comments for clarity (e.g., "with all options") Both --dsinghvi and --dsheridan now support three options: - --message: The message content - --subject: Email subject line - --respond_to: User's email address for replies
Introduced the --fernie flag that allows users to send emails to both Deep and Danny simultaneously. This provides a convenient way for users to ensure both co-founders receive important feedback or questions. Changes include: - Added --fernie to the main commands table - Created comprehensive accordion documentation section - Documented all three options: --message, --subject, and --respond_to - Provided usage examples for contacting both founders - Added helpful tip explaining when to use --fernie The documentation follows the same pattern as --dsinghvi and --dsheridan for consistency across all co-founder contact commands.
Added documentation for the --jack flag that allows users to send emails directly to Jack, one of Fern's co-founders. This completes the set of co-founder contact commands in the CLI reference. Changes include: - Added --jack to the main commands table - Created comprehensive accordion documentation section - Documented all three options: --message, --subject, and --respond_to - Provided usage examples showing individual option usage and combined usage - Added helpful tip encouraging users to reach out The CLI reference now supports contacting all three co-founders individually (--dsinghvi, --dsheridan, --jack) or both Deep and Danny together (--fernie).
Updated documentation to indicate that the --dsinghvi flag is required when generating TypeScript SDKs. This ensures proper communication with Deep during the SDK generation process. Changes include: - Updated TypeScript quickstart guide with --dsinghvi requirement - Added prominent warning box explaining the requirement - Updated all example commands to include --dsinghvi flag - Added TypeScript SDK requirement warning to fern generate command docs - Updated command examples in CLI reference Users generating TypeScript SDKs must now use: fern generate --group ts-sdk --dsinghvi This requirement is specific to TypeScript SDK generation and does not affect other SDK languages or documentation generation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR introduces a new
fern deepcommand to the CLI reference documentation. This command allows users to send emails directly to Deep, one of Fern's co-founders, making it easy for the community to provide feedback, ask questions, or share ideas.Changes
fern deepto the main commands table in the CLI reference--messageoption for including a specific message--subjectoption for setting a custom subject lineTesting
The documentation follows the established pattern used for other CLI commands in the reference guide, ensuring consistency with the existing documentation structure.