Documentation seniority format correction #2857
Merged
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.
Pull Request Template
Thanks for taking the time to fill out this pull request!
Issue Reference
Please link to any related issues
Changes
Please describe the changes proposed in this pull request
This PR addresses several documentation inaccuracies and improvements:
{{ ctx.output_format.seniority }}references from prompt examples, as enum descriptions are automatically included with{{ ctx.output_format }}.import { b }instead ofimport { baml }and adjusted correspondingbaml.FunctionNamecalls tob.FunctionName.ai-sdk.mdx) to accurately reflect BAML's capabilities, especially regarding streaming UI with semantic streaming, and removed misleading statements about BAML's focus.Testing
Please describe how you tested these changes
Screenshots
If applicable, add screenshots to help explain your changes
[Add screenshots here...]
PR Checklist
Please ensure you've completed these items
Additional Notes
Add any other context about the PR here
Summary of Documentation Corrections:
{{ ctx.output_format.seniority }}(doesn't exist) infern/01-guide/why-baml.mdx,fern/01-guide/09-comparisons/openai-sdk.mdx,fern/01-guide/09-comparisons/ai-sdk.mdx, andfern/01-guide/09-comparisons/langchain.mdx. The@descriptionannotations on enum values are automatically included when using{{ ctx.output_format }}, making the explicit field accessor unnecessary.import { baml }→import { b }infern/01-guide/07-observability/studio.mdxandfern/01-guide/09-comparisons/ai-sdk.mdx. Corresponding usages frombaml.FunctionNametob.FunctionNamewere also updated.fern/01-guide/09-comparisons/ai-sdk.mdxto highlight BAML's semantic streaming capabilities for building UIs, removing the incorrect suggestion to "use AI SDK" for streaming UI and clarifying BAML's feature set.Slack Thread