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

feat: add warning about v8 snapshots to troubleshooting guide #4825

Merged
merged 6 commits into from
Nov 2, 2022

Conversation

ryanthemanuel
Copy link
Contributor

Add warning about v8 snapshots to troubleshooting guide

@vercel
Copy link

vercel bot commented Nov 1, 2022

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

Name Status Preview Updated
cypress-documentation ✅ Ready (Inspect) Visit Preview Nov 2, 2022 at 4:01PM (UTC)

content/guides/references/troubleshooting.md Outdated Show resolved Hide resolved
Comment on lines 647 to 649
The installed application comes with the fully transpiled, unobfuscated
JavaScript source code that you can hack on. You might want to directly modify
the installed app code to:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With V8 snapshots, "fully transpiled, unobfuscated JavaScript source code" isn't true, right? I think we should remove that language and anything below that doesn't apply with snapshots. The docs only cover the current version of Cypress, so we should target this towards the release-11.0 branch and the verbiage should be more clear about what can and can't be modified by users.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah gotcha. Yeah I thought that we potentially tried to cover multiple versions, but I can update this to be specific to 11.0

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Thinking about this more, I think this section will cause more confusion than any benefit with leaving it. I decided to remove it instead:
dfbab20 (#4825)


You can change anything in the JavaScript code:

<DocsImage src="/img/guides/troubleshooting/source-code.png" alt="Source code of Cypress in a text editor" ></DocsImage>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can remove this image as well. It doesn't seem to be referenced anywhere else.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed: 92e4ed8 (#4825)

@ryanthemanuel ryanthemanuel changed the base branch from master to release-11.0.0 November 2, 2022 16:41
@ryanthemanuel ryanthemanuel merged commit 43d4f90 into release-11.0.0 Nov 2, 2022
@ryanthemanuel ryanthemanuel deleted the ryanm/feat/v8-snapshots branch November 2, 2022 16:41
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.

3 participants