Skip to content

Enhance documentation on Node.js API compatibility and polyfills, add… - #2272

Merged
VitorAEltz merged 1 commit into
mainfrom
EDU-6567-review-polyfills-doc
Jul 22, 2026
Merged

Enhance documentation on Node.js API compatibility and polyfills, add…#2272
VitorAEltz merged 1 commit into
mainfrom
EDU-6567-review-polyfills-doc

Conversation

@gabriel-alves-azion

@gabriel-alves-azion gabriel-alves-azion commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

…ing status legends and deployment instructions for Azion functions.

Related issue: EDU-6567

docs: fix polyfill compatibility and add deploy section

Summary

This PR addresses two documentation accuracy issues and adds missing deployment guidance for the polyfills guide.

Changes

use-polyfills.mdx (PT-BR + EN)

  • Added deploy section after the local testing step (azion dev). The guide previously ended without explaining how to publish the function to the Azion Platform.
  • Added step 13 with the azion deploy command.
  • Added a table documenting useful deploy flags (--auto, --workers, --dry-run) with descriptions sourced directly from the CLI source code.
  • Added a usage example combining --auto and --workers.
  • Added a :::note callout reminding users to configure the polyfills property in azion.config.js before deploying.

node.mdx / cells-node.mdx (PT-BR + EN)

  • Corrected compatibility status for dns, dns/promises, and os modules:
    • Before: 🟢 Supported (EN) / 🟢 Suportada (PT-BR)
    • After: 🔴 Build-only (EN) / 🔴 Somente para build (PT-BR)
    • These modules are included as stubs to allow NPM packages with static dependencies to compile, but their API calls do not function at runtime due to Azion Cells environment restrictions.
  • Added status legend before the polyfills table, explaining the three support levels (🟢 / 🟡 / 🔴).
  • Added architectural callout (:::note[About the Azion Cells runtime environment]) explaining that functions run inside V8 Isolate-based Cells, which block OS property access, native DNS resolution, and low-level socket syscalls for multi-tenant security reasons.

Motivation

  • The dns, dns/promises, and os modules were incorrectly documented as fully supported, which could lead developers to ship broken code expecting runtime DNS resolution or OS information.
  • The os module does not work at runtime due to Cells' isolation model (no access to underlying OS properties).
  • The polyfills guide lacked a deploy step, leaving developers without a complete end-to-end workflow.

Files changed

  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/use-polyfills.mdx
  • src/content/docs/pt-br/pages/devtools/azion-edge-runtime/compatibilidade/node-polyfills/node.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/compatibility/use-polyfills.mdx
  • src/content/docs/en/pages/devtools/azion-edge-runtime/compatibility/node-polyfills/cells-node.mdx

…ing status legends and deployment instructions for Azion functions.
@gabriel-alves-azion
gabriel-alves-azion requested a review from a team as a code owner July 16, 2026 12:45
@VitorAEltz
VitorAEltz merged commit cbdf4ab into main Jul 22, 2026
3 checks passed
@VitorAEltz
VitorAEltz deleted the EDU-6567-review-polyfills-doc branch July 22, 2026 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants