Skip to content

Broken links in README #663

@MikeMcC399

Description

@MikeMcC399

Description

Some links in README.md do not work.

Steps to reproduce the issue

Execute npm run check:markdown and look for Status 400 (Bad Request) and 404 (Not Found) errors.

  [✖] /examples/v10/component-tests/ → Status: 400
  [✖] #record-test-results-on-cypress-dashboard → Status: 404
  [✖] examples/start-and-yarn-workspaces → Status: 400

Note that executing npm run check:markdown will also show 403 Forbidden link errors for links to the github.com domain even though the links work when they are clicked on manually. This is a separate problem, which is described in issue #664.

Expected behavior

npm run check:markdown should not produce any 400 (Bad Request) or 404 (Not Found) errors.

Suggested Fixes

Correct the links in README.md as follows:

Old New
/examples/v10/component-tests/ examples/v10/component-tests/
#record-test-results-on-cypress-dashboard #record-test-results-on-cypress-cloud
examples/start-and-yarn-workspaces examples/v10/start-and-yarn-workspaces

Also update the README - Yarn workspaces example adding v10 to the working-directory.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions