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

docs: fix @cypress/grep readme links #30688

Merged
merged 2 commits into from
Dec 2, 2024

Conversation

MikeMcC399
Copy link
Contributor

Additional details

In the npm/grep/README.md for the npm module @cypress/grep:

  1. The Table of Contents is outdated, causing several invalid section headings / bookmarks to be displayed. These are removed from the end of the TOC:
    [✖] #videos--blog-posts → Status: 404
    [✖] #blog-posts → Status: 404
    [✖] #mit-license → Status: 404
  2. #grepfilterspecs is now #pre-filter-specs-grepfilterspecs. This is corrected:
    [✖] #grepfilterspecs → Status: 404
  3. The "See also" section is eliminated, since the two repos in that section are now both archived and therefore de facto unsupported, although they are not explicitly deprecated in the npm registry:
  4. References and links to legacy cypress/integration/ are corrected to cypress/e2e
  5. Support via email and tweet is removed

Steps to test

npm install markdown-link-check -g
git clone https://github.com/cypress-io/cypress
cd cypress
markdown-link-check npm/grep/README.md

How has the user experience changed?

Users viewing npm/grep/README.md will not encounter bad or outdated links.

This PR does not itself cause a new version of @cypress/grep to be released, so the npm registry README copy will continue to be outdated.

PR Tasks

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review December 2, 2024 10:37
@jennifer-shehane jennifer-shehane merged commit 9c2277e into cypress-io:develop Dec 2, 2024
31 of 33 checks passed
@MikeMcC399 MikeMcC399 deleted the update/grep-readme branch December 2, 2024 16:15
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.

4 participants