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 readme links for cypress documentation restructuring #1311

Merged
merged 5 commits into from
Nov 18, 2024

Conversation

MikeMcC399
Copy link
Collaborator

Issue

Some links to https://on.cypress.io/, used in the README document, no longer bring up the intended content.

The site https://docs.cypress.io/ was restructured in October 2024 and the use of https://on.cypress.io/ links has not redirected all links to approprate replacement content.

Change

In the README document, replace links to https://on.cypress.io/ that are not showing required content, using either other https://on.cypress.io/ links or instead https://docs.cypress.io/ with appropriate pages and bookmarks.

Verification

npm ci
npx markdown-link-check README.md

@MikeMcC399 MikeMcC399 added bug Something isn't working documentation Improvements or additions to documentation labels Nov 16, 2024
@MikeMcC399 MikeMcC399 self-assigned this Nov 16, 2024
@cypress-app-bot
Copy link

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review November 16, 2024 16:29
Copy link
Contributor

@AtofStryker AtofStryker left a comment

Choose a reason for hiding this comment

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

Thank you for fixing these @MikeMcC399! I think we want to keep the links using to on.cypress.io but correct the route. These suggestions should still work.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MikeMcC399
Copy link
Collaborator Author

@AtofStryker

Thank you for the review and suggestions!

I was unsure what to do with deep links. There is no externally viewable documentation about the right way to link to the docs site and the repro for on.cypress.io isn't accessible externally either, so I can't see what redirects have been set up.

@AtofStryker
Copy link
Contributor

@AtofStryker

Thank you for the review and suggestions!

I was unsure what to do with deep links. There is no externally viewable documentation about the right way to link to the docs site and the repro for on.cypress.io isn't accessible externally either, so I can't see what redirects have been set up.

Completely understand. A lot of those links are managed internally, hence why I figured I could provide the recommendations so you aren't in the dark 😃

@AtofStryker AtofStryker merged commit 3b16f4c into cypress-io:master Nov 18, 2024
74 checks passed
@MikeMcC399 MikeMcC399 deleted the docs/restructure-fix branch November 18, 2024 16:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants