Skip to content
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

Merged
merged 1 commit into from
Aug 18, 2023

Conversation

alicewriteswrongs
Copy link
Contributor

A small documentation PR just adding a bit of explanation of what this field is for.

@alicewriteswrongs alicewriteswrongs requested a review from a team as a code owner August 2, 2023 20:06
@alicewriteswrongs alicewriteswrongs requested review from rwaskiewicz and tanner-reits and removed request for a team August 2, 2023 20:06
@vercel
Copy link

vercel bot commented Aug 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
stencil-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 18, 2023 3:08pm

Copy link
Member

@rwaskiewicz rwaskiewicz left a 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?

Copy link
Member

@tanner-reits tanner-reits left a 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.

@alicewriteswrongs
Copy link
Contributor Author

@rwaskiewicz makes sense, I just updated the copy in line with your suggestions

@alicewriteswrongs alicewriteswrongs merged commit d6c56ea into main Aug 18, 2023
4 checks passed
@alicewriteswrongs alicewriteswrongs deleted the ap/experimental-slot-fixes branch August 18, 2023 15:08
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.

None yet

3 participants