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

Update our internal documentation on polyfilling #3722

Closed
1 task
Tracked by #3948
domoscargin opened this issue May 30, 2023 · 4 comments
Closed
1 task
Tracked by #3948

Update our internal documentation on polyfilling #3722

domoscargin opened this issue May 30, 2023 · 4 comments
Labels
documentation User requests new documentation or improvements to existing documentation javascript

Comments

@domoscargin
Copy link
Contributor

domoscargin commented May 30, 2023

What

Update our polyfilling doc

Why

Previously, we used the polyfill.io service to generate polyfills and detect the need for them. We will likely move to transpiling our code, and automatically polyfilling missing APIs in older browsers. Our documentation should be updated to reflect this new process.

Who needs to work on this

Developers, Technical writer

Who needs to review this

Developers, Technical writer

Done when

  • Our polyfilling documentation reflects our chosen method for polyfilling
@domoscargin domoscargin added documentation User requests new documentation or improvements to existing documentation javascript labels May 30, 2023
@domoscargin domoscargin changed the title We've updated our internal documentation on polyfilling Update our internal documentation on polyfilling May 30, 2023
@domoscargin
Copy link
Contributor Author

@claireashworth Tagging you so this is on your radar

@romaricpascal
Copy link
Member

romaricpascal commented Jul 20, 2023

Would be great to make sure we document the different parts around the transpilation (and not just the polyfilling): the tools (browserslist, Babel) as well as stuff like Babel's mapping from browser to transforms that need applying (or core-js's/es-shim's one if we end up using either) to help look things up if we get reports of stuff not working in a specific browser.

@romaricpascal
Copy link
Member

Also noting that this issue is closely linked with (duplicate of, even, maybe) #2159

@36degrees 36degrees mentioned this issue Jan 19, 2024
5 tasks
@36degrees
Copy link
Contributor

Although the documentation is rather terse, I think it meets the 'done when' for this issue ('Our polyfilling documentation reflects our chosen method for polyfilling') so I'm going to call this done.

We can revisit as our approach to polyfilling evolves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation User requests new documentation or improvements to existing documentation javascript
Projects
None yet
Development

No branches or pull requests

3 participants