Skip to content

Add Bun runtime documentation#17935

Open
jkodroff wants to merge 2 commits intomasterfrom
jkodroff/add-bun-docs
Open

Add Bun runtime documentation#17935
jkodroff wants to merge 2 commits intomasterfrom
jkodroff/add-bun-docs

Conversation

@jkodroff
Copy link
Member

@jkodroff jkodroff commented Mar 12, 2026

Documents Bun as a first-class runtime (runtime: bun) alongside Node.js, with incompatibility warnings for function serialization, dynamic providers, and magic Lambda functions across relevant pages.

Fixes pulumi/pulumi#22040
Fixes #17923

Documents Bun as a first-class runtime (runtime: bun) alongside Node.js,
with incompatibility warnings for function serialization, dynamic providers,
and magic Lambda functions across relevant pages.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jkodroff
Copy link
Member Author

Marked do-not-merge since the release has not yet gone out.

@jkodroff jkodroff requested a review from julienp March 12, 2026 14:54
@claude
Copy link
Contributor

claude bot commented Mar 12, 2026

Docs Review — PR #17935

Scope: 6 files changed (+40 −4) — Bun runtime documentation across docs pages.

Overall this is a well-structured PR that adds clear, consistent warnings about Bun's limitations across the relevant pages. A few items to address:

Issues

1. Shortcode syntax inconsistency (STYLE-GUIDE.md violation)

The notes shortcode is listed in STYLE-GUIDE.md as a percent-sign shortcode ({{% notes %}}) because it processes Markdown content. Two of the new additions use angle brackets instead:

  • content/docs/iac/concepts/functions/function-serialization.md (line 32): Uses {{< notes type="warning" >}} — the existing notes on this page all use {{% notes %}}, so this is inconsistent both with the style guide and the surrounding file.

  • content/docs/iac/clouds/aws/guides/lambda.md (line 141): Uses {{< notes type="warning" >}}.

  • content/docs/iac/concepts/providers/dynamic-providers.md (line 35): Correctly uses {{% notes type="warning" %}}.

{{% notes type="warning" %}}

These should all use {{% notes %}} / {{% /notes %}} for consistency with the style guide and surrounding content.

2. Consider linking to Bun on first mention

In content/docs/iac/languages-sdks/javascript/_index.md (line 49), "Bun" is introduced without a hyperlink. Consider linking to bun.sh on first mention to help readers unfamiliar with it:

[Bun](https://bun.sh) is also supported as a first-class runtime.

Similarly, the intro paragraph at line 28 mentions "Bun runtimes" — that could be the first-mention link instead.

Looks good

  • The runtime list updates in plugins.md and project-file.md are accurate and correctly add the Oxford comma.
  • Warnings are placed logically near the relevant feature descriptions (function serialization, dynamic providers, magic Lambda functions).
  • The Bun runtime section in _index.md is well-structured under the existing "Installation requirements" hierarchy.
  • Internal links to /docs/iac/concepts/functions/function-serialization/ are correct.
  • The "Bun runtime options" section in plugins.md is placed in the right order (after Java, before YAML).

Mention me (@claude) if you'd like additional reviews or help with fixes.

🤖 Generated with Claude Code

@pulumi-bot
Copy link
Collaborator

@jkodroff
Copy link
Member Author

@claude Fix the issues you found

@claude
Copy link
Contributor

claude bot commented Mar 12, 2026

Claude finished @jkodroff's task in 57s —— View job


Fixes applied

  • Read the affected files
  • Fix shortcode syntax in lambda.md ({{< notes >}}{{% notes %}})
  • Fix shortcode syntax in function-serialization.md ({{< notes >}}{{% notes %}})
  • Add Bun link on first mention in _index.md ([Bun](https://bun.sh))
  • Commit and push changes

All three issues from the previous review have been fixed in commit 216250b.
|

- Use {{% notes %}} instead of {{< notes >}} in lambda.md and function-serialization.md
- Link Bun on first mention in javascript/_index.md

Co-authored-by: Josh Kodroff <jkodroff@users.noreply.github.com>
@jkodroff jkodroff assigned jkodroff and julienp and unassigned jkodroff Mar 12, 2026
@jkodroff
Copy link
Member Author

Assigning to @julienp with the intent that he can merge it once this release goes out (assuming the info is correct, and LGTM).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for bun support Document Bun runtime

3 participants