Update tools section for v3 #1118
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
augustjk
commented
May 15, 2023
augustjk
commented
- Update all ES level references to ES2021.
- Add what browsers we test on and any older browsers might work but are best effort.
- Remove detailed description of legacy browsers and link back to v2/tools/requirements for that.
- Remove bundling for legacy browsers.
- Update test section links for legacy browser and polyfills to v2 docs. Maybe these should just be removed all-together?
|
A live preview of this PR will be available at the URL(s) below. https://pr1118-f325f10---lit-dev-5ftespv5na-uc.a.run.app/ |
| @@ -43,153 +43,8 @@ Webpack automatically handles bare module specifiers; for Rollup, you'll need a | |||
|
|
|||
| ### Modern browser breakdown | |||
|
|
|||
| All modern browsers update automatically and users are highly likely to have a recent version. The following table lists the minimum version of each major browser that natively supports ES2019 and web components, the key features on which Lit relies. | |||
| All modern browsers update automatically and users are highly likely to have a recent version. Lit and related libraries are tested on the latest minus 2 major versions of Chromium and Safari, and Firefox Extended Support Release. Older versions may still work but will be at best efforts without guarantee. | |||
There was a problem hiding this comment.
instead of "are tested on the latest minus 2 major versions of Chrome and Safari, suggest:
"are tested on the latest two major versions of..."
AndrewJakubowicz
approved these changes
May 15, 2023
AndrewJakubowicz
added a commit
that referenced
this pull request
May 15, 2023
* Copy over all unversioned content into a versioned directory The only file changed in the move is the root `docs.json` file. Instead a `v2.json` file was added. * Add initial build-unversioned-docs script. This copies over and adds the correct permalinks to the selected version content. Currently moving `v2` -> `unversioned`. * Fix wireit so npm run dev doesnt spin infinitely. * Add rel=canonical link from latestVersion to unversioned page. * Make all authored cross links versioned. Unversioned links will be generated automatically by the generated unversioned pages. * Add fixUnversionedCrossLinks so unversioned cross-linking work. This works by piping all the content through a function that will fix cross links on unversioned pages. * Add integration tests checking added features. * unblock failing link by adding it to the known good list. * Fix api shortcode such that it uses a versioned URL The versioned URL is stripped for unversioned URLs by our tooling. Add a test to confirm this behavior. * Apply code review feedback. Thank you! * Code review feedback from Justin - Replaced sync fs with async fs. - Made lightweight YAML parser more robust using regex. * Add undiscoverable v3 generated documentation. Currently the Lit 3 commit being used is d04a3e30eb3ae3520fb0ac163fb5ddbbf6030620 because lit/lit#3894 fixes building Lit 3. API docs are visible at /docs/api/v3/ * Explicitly bump node heap size. This will hopefully avoid the Github Actions failures. * Add types/codemirror to fix TS 5 error. Thank you Augustine! Re-ran generator with no content changes. * Remove unneeded dependency Co-authored-by: Augustine Kim <[email protected]> * Code review feedback with Wireit env. * Fix formatting & filter out v3/api/index.html page * Copy over v2 docs to v3 unchanged. * Add banner and config * Fix all cross links in v3 docs to be v3 specific. - Find replace all /v2/ with /v3/ - Replace api shortcode with api-v3 shortcode - linking to v3 api docs * Add Lit 3.0 upgrade guide - first attempt. * Add v3 to the Lit.dev dropdown. * Upstream ssr client-usage docs to v3 page. This makes the page a duplicate of the v2 page. Git for some reason did not include these changes when merging from main. * Remove pre-release v3 docs from search index * Add version links so that v2 <-> v3 changing doesnt change page. A user on v2 docs for a certain page should remain on that page when switching to v3 and vice-versa. This change makes it so switching between v2 and v3 will keep you on the same page, but provide the different versions of the page. Tested manually on every single page. * Update tools section for v3 (#1118) * Update tools section for v3 * Better wording for versions tested * Add pre-releases banner content to v3 banner. * Update packages/lit-dev-content/site/docs/v3/releases/upgrade.md Co-authored-by: Augustine Kim <[email protected]> * Update packages/lit-dev-content/site/docs/v3/releases/upgrade.md Co-authored-by: Augustine Kim <[email protected]> * Lit 3.0 pre-releases blog post (#1115) * Lit 3.0 pre-releases blog post * Apply suggestions from code review * Add link to upgrade guide --------- Co-authored-by: Augustine Kim <[email protected]> * Remove a small paragraph that didn't really make sense from upgrade. * Add missing word "can". * Fix blog dropdown referring 3.0 -> v3 --------- Co-authored-by: Augustine Kim <[email protected]> Co-authored-by: Justin Fagnani <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.