-
Notifications
You must be signed in to change notification settings - Fork 383
docs: add processStylexRules API documentation #1445
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
docs: add processStylexRules API documentation #1445
Conversation
This addresses issue facebook#1061 by documenting the processStylexRules API that is exported from @stylexjs/babel-plugin. The documentation covers: - Function purpose and usage - Function signature with TypeScript types - Configuration options (useLayers, enableLTRRTLComments, etc.) - Example for custom bundler integrations
|
@Ankitsinghsisodya is attempting to deploy a commit to the Meta Open Source Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive API documentation for the processStylexRules function exported from @stylexjs/babel-plugin, addressing issue #1061. This function is essential for developers building custom bundler integrations.
Changes:
- New documentation file explaining the
processStylexRulesAPI, including function signature, configuration options, and usage examples - Updated navigation to include link to the new documentation
- Updated meta.json to include the new page in the documentation structure
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/docs/content/docs/api/configuration/processStylexRules.mdx | Comprehensive documentation for processStylexRules API with examples and configuration options |
| packages/docs/content/docs/api/index.mdx | Added navigation link to processStylexRules documentation |
| packages/docs/content/docs/api/configuration/meta.json | Added processStylexRules.mdx to pages array for documentation structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs/content/docs/api/configuration/processStylexRules.mdx
Outdated
Show resolved
Hide resolved
mellyeliu
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably live in a section in the babel-plugin README.md instead of within the configs docs, since it’s only relevant for custom integrations.
packages/docs/content/docs/api/configuration/processStylexRules.mdx
Outdated
Show resolved
Hide resolved
packages/docs/content/docs/api/configuration/processStylexRules.mdx
Outdated
Show resolved
Hide resolved
Addresses review feedback: - Move documentation to babel-plugin README.md (for custom integrations) - Remove legacy Meta-internal options (enableLTRRTLComments, useLegacyClassnamesSort) - Delete standalone processStylexRules.mdx from docs site - Update navigation files (meta.json, index.mdx)
|
@mellyeliu sir, I have done all the changes suggested by you. |
What changed / motivation?
This addresses issue #1061 by documenting the
processStylexRulesAPI that is exported from@stylexjs/babel-plugin. This API is essential for people building custom bundler integrations or improving official integrations.The documentation covers:
useLayers,legacyDisableLayers)Linked PR/Issues
Fixes #1061
Additional Context
This is a documentation-only change. No code changes or tests required.
Files modified:
processStylexRulessection)Files deleted:
Pre-flight checklist
Contribution Guidelines