Skip to content

Conversation

@hellovai
Copy link
Contributor

Pull Request Template

Thanks for taking the time to fill out this pull request!

Issue Reference

Please link to any related issues

  • This PR fixes/closes #[issue number]

Changes

Please describe the changes proposed in this pull request

This PR addresses several documentation inaccuracies and improvements:

  • Removed incorrect {{ ctx.output_format.seniority }} references from prompt examples, as enum descriptions are automatically included with {{ ctx.output_format }}.
  • Updated TypeScript code snippets to use import { b } instead of import { baml } and adjusted corresponding baml.FunctionName calls to b.FunctionName.
  • Revised the AI SDK comparison page (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

  • Unit tests added/updated
  • Manual testing performed (verified rendered documentation and code snippets)
  • Tested in [environment]

Screenshots

If applicable, add screenshots to help explain your changes

[Add screenshots here...]

PR Checklist

Please ensure you've completed these items

  • I have read and followed the contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

Additional Notes

Add any other context about the PR here

Summary of Documentation Corrections:

  • Fixed {{ ctx.output_format.seniority }} (doesn't exist) in fern/01-guide/why-baml.mdx, fern/01-guide/09-comparisons/openai-sdk.mdx, fern/01-guide/09-comparisons/ai-sdk.mdx, and fern/01-guide/09-comparisons/langchain.mdx. The @description annotations on enum values are automatically included when using {{ ctx.output_format }}, making the explicit field accessor unnecessary.
  • Fixed import { baml }import { b } in fern/01-guide/07-observability/studio.mdx and fern/01-guide/09-comparisons/ai-sdk.mdx. Corresponding usages from baml.FunctionName to b.FunctionName were also updated.
  • Fixed the AI SDK comparison in fern/01-guide/09-comparisons/ai-sdk.mdx to 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

Open in Cursor Open in Web

@cursor
Copy link

cursor bot commented Dec 20, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

@vercel
Copy link

vercel bot commented Dec 20, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Review Updated (UTC)
promptfiddle Skipped Skipped Dec 20, 2025 8:54am

@hellovai hellovai temporarily deployed to boundary-tools-dev December 20, 2025 08:55 — with GitHub Actions Inactive
@hellovai hellovai temporarily deployed to boundary-tools-dev December 20, 2025 08:55 — with GitHub Actions Inactive
@hellovai hellovai temporarily deployed to boundary-tools-dev December 20, 2025 08:55 — with GitHub Actions Inactive
@github-actions
Copy link

@github-actions
Copy link

@hellovai hellovai marked this pull request as ready for review December 24, 2025 19:04
@hellovai hellovai added this pull request to the merge queue Dec 24, 2025
Merged via the queue into canary with commit 3bebb8c Dec 24, 2025
37 checks passed
@hellovai hellovai deleted the cursor/documentation-seniority-format-correction-3078 branch December 24, 2025 19:19
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.

3 participants