-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
v3 docs availability and migration guide #8703
Comments
|
dummdidumm
added a commit
that referenced
this issue
Jun 15, 2023
note some inline, drive-by-fix in custom element docs closes #8703
dummdidumm
added a commit
that referenced
this issue
Jun 16, 2023
note some inline, drive-by-fix in custom element docs closes #8703
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the problem
When we launch the v4 docs, we should make sure they cover v3 as well. I don't think we need a separate version of the docs for v3 since the changes aren't that large, but can just call the differences out inline
Describe the proposed solution
I think we could note these changes inline:
|local
default for transitions in v4format
option being available for v3 (chore: unbundled esm #8613)a11y no-noninteractive-element-interactions
anda11y-no-static-element-interactions
only available in v4The custom elements changes are larger, but still possibly could be handled inline. We could also say if you're still on v3, see the migration guide for a comparison of the APIs. Or maybe we make a
/docs/custom-elements-v3
page that's only linked to from the v4 custom elements docs and leave it out of the menu if we really need more docs.Some of the types are also different, but I think we can just put a note at the top to say a few of the types have changed. If you're on v3, please use your IDE to reference the types.
Also of note, we need to make sure the REPL works in v4: sveltejs/sites#486
Alternatives considered
Whole separate site for v3, host multiple versions with
/docs
with a version switcher (we'll probably want to do this when v5 comes so maybe do it early?), or throw users to the wildImportance
nice to have
The text was updated successfully, but these errors were encountered: