Skip to content

[Documentation:Developer] Add Cypress npm update note#761

Merged
bmcutler merged 2 commits into
mainfrom
docs-cypress-npm-update
Jun 10, 2026
Merged

[Documentation:Developer] Add Cypress npm update note#761
bmcutler merged 2 commits into
mainfrom
docs-cypress-npm-update

Conversation

@dandrecollins07-ctrl

Copy link
Copy Markdown
Contributor

Why is this Change Important & Necessary?

Some developers may encounter issues launching Cypress after installation. Adding a troubleshooting note provides a potential solution and can reduce confusion during setup.

What is the New Behavior?

A troubleshooting note has been added to the Cypress documentation recommending npm update if issues occur when launching Cypress.

Automated Testing & Documentation

Documentation update only.

Other Information

N/A

Screenshot:
Screenshot 2026-06-10 103256

@github-project-automation github-project-automation Bot moved this to Seeking Reviewer in Submitty Development Jun 10, 2026
@dandrecollins07-ctrl dandrecollins07-ctrl changed the title [Documentation:Cypress] Add npm update troubleshooting note to Cypress documentation [Developer] Document Cypress npm update Jun 10, 2026
@dandrecollins07-ctrl dandrecollins07-ctrl changed the title [Developer] Document Cypress npm update [Documentation:Developer] Add Cypress npm update note Jun 10, 2026
@roye2 roye2 self-requested a review June 10, 2026 18:57

@roye2 roye2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think the wording of the message is okay, but I think it would be better to have the note appear at the bottom after all the other things under the 'Installation' header. Also, if you could unitalicize npm update I think it would be a bit more legible.
(to do that, replace it with *npm update*)

@github-project-automation github-project-automation Bot moved this from Seeking Reviewer to Work in Progress in Submitty Development Jun 10, 2026
@dandrecollins07-ctrl

Copy link
Copy Markdown
Contributor Author

I think the wording of the message is okay, but I think it would be better to have the note appear at the bottom after all the other things under the 'Installation' header. Also, if you could unitalicize npm update I think it would be a bit more legible. (to do that, replace it with npm update)

Changes done, thank you!

@roye2 roye2 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Final fixes look good, I think this is ready to merge!

@github-project-automation github-project-automation Bot moved this from Work in Progress to Awaiting Maintainer Review in Submitty Development Jun 10, 2026
@bmcutler bmcutler merged commit ff1adcc into main Jun 10, 2026
3 checks passed
@bmcutler bmcutler deleted the docs-cypress-npm-update branch June 10, 2026 21:41
@github-project-automation github-project-automation Bot moved this from Awaiting Maintainer Review to Done in Submitty Development Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants