-
Notifications
You must be signed in to change notification settings - Fork 306
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
Docs: Document VarGroup and Theme types #431
Conversation
compressed-size: runtime library Size change: 0.00 kB View unchanged
|
compressed-size: e2e bundles Size change: 0.00 kB View unchanged
|
I feel that the description and explanation of the second type argument to both Otherwise it's all very clear and well articulated |
Thanks for working on it 😊 IMO
What I mean: the users could miss the use case and stuck on it because that want to fully understand it. If they can't, an idea could pop in their mind: "stylex is hard". And it's a lose-lose. My Pareto-principle suggestion here is: just mention that "this technique is commonly referred as Branded Types" so people have something to Google for. And if the technique doesn't click for them, the result is that in their mind "oh, TypeScript is hard, but stylex is cool" pops 😊 |
I think giving a concrete example of when it would be needed would help in both explaining exactly what it is, and that it's an advanced feature that should hardly ever be used. Maybe something along the lines of The second type argument should be rarely needed, and is meant for advanced cases where type branding might be desirable.
For example, ... |
Well done!! 😊 |
This makes it completely clear in my opinion. There's a small typo though: The of us missing |
What changed / motivation ?
Document public types
VarGroup
andTheme
. The writing could probably be better,but sharing early for feedback.
Linked PR/Issues
Fixes #424