feat(cli): add fern docs prettify command #10753
Open
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.
Description
Linear ticket: N/A
Adds a new
fern docs prettifycommand that uses AI (via BAML) to analyze markdown documentation files and suggest improvements using Fern's documentation components. The command helps enhance docs by intelligently adding Steps, Cards, Callouts, Code Blocks with tabs, Endpoint snippets, and other Fern components where appropriate.Changes Made
PrettifyDocsBAML function with comprehensive prompt for analyzing markdown and suggesting Fern component improvementsprettifyDocsCommand.tshandler with:fern docs prettify <path>subcommand underdocsTesting
--dry-run=falseto verify file writing worksHuman Review Checklist
High Priority:
packages/cli/ai/baml_src/main.baml- does it provide clear enough instructions for the LLM?prettifyFilefunction)FERN_COMPONENTS_REFERENCEcontains accurate examples of all Fern componentsMedium Priority:
cli.tsis correctLow Priority:
Notes
--dry-run=falseto modify files