-
Notifications
You must be signed in to change notification settings - Fork 423
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(config): add docs for new experimentalSlotFixes
config value
#1196
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
I think for this field, we're going to want to be pretty descriptive about what this field is, how it's being used, and what folks should expect if they enable it now (and in the future). At the moment, this is going to be one of (if not the) primary source of information for this flag. With that in mind, I think we'd want something to the effect of:
A flag introduced in Stencil to enable new slot-related fixes to the Stencil runtime.
When enabled, this flag will enable the following flags:
- [list}
This flag also contains fixes for the following issues that do not have a configuration flag associated with them:
- [List of issues]
Fixes to the runtime that are a part of this flag will be added over the course of Stencil v4, with the intent of making these the default behavior in Stencil v5.
New fixes added to this flag are not subject to Stencil's semantic versioning policy.
The "This flag also contains fixes for the following issues" part would have to come later though, since we don't have any ATM.
But that's all just an example of what I'm thinking of in terms of things we should tell folks about. Thoughts?
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.
Agree this should be pretty descriptive. Might be good to also add a sentence like "This option will override any values specified in the extras
config section for slot related fixes/polyfills". This way, users understand that this takes precedence.
305f3bf
to
ee6771c
Compare
@rwaskiewicz makes sense, I just updated the copy in line with your suggestions |
81835a0
to
626697e
Compare
A small documentation PR just adding a bit of explanation of what this field is for.