Skip to content

Conversation

@tharani-2006
Copy link

@tharani-2006 tharani-2006 commented Dec 21, 2025

Closes #32380

What I did

Added a dedicated Globals page to the API documentation to give globals first-class visibility alongside parameters.

The new page explains what globals are, how they differ from parameters, and how to use them across preview, manager, and MDX contexts, with guidance on common pitfalls.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

No manual testing required.
This PR is documentation-only and does not affect runtime behavior.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Notes

  • Adds a dedicated Globals page to the API section
  • Documents globals usage in preview, manager, and MDX contexts
  • Uses CodeSnippets for all examples (no inline code blocks)
  • Improves clarity and discoverability compared to existing docs

Thanks!

@tharani-2006
Copy link
Author

Hi 👋,

PR is ready for review. I’m happy to iterate on any feedback or requested changes.

Thanks!

@jonniebigodes jonniebigodes self-assigned this Dec 21, 2025
@github-actions github-actions bot added the Stale label Jan 2, 2026
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.

[Documentation]: Globals page in API section

2 participants