Skip to content

archived legacy failing example used to demonstrate / explain project cli option #5322

Open
@MikeMcC399

Description

@MikeMcC399

Subject

Guides > Command Line

Description

Concerns the page: https://docs.cypress.io/guides/guides/command-line moved to https://docs.cypress.io/app/references/command-line

both refer to https://github.com/cypress-io/cypress-test-nested-projects as the only explanation of the Cypress --project cli option:

To see this in action we've set up an example repo to demonstrate this here.

The repo cypress-io/cypress-test-nested-projects however is not suitable for this purpose. It:

  • is based on legacy Cypress configuration using cypress.json instead of cypress.config.js or cypress.config.ts
  • shows a failing CircleCI badge
  • is not configured for CircleCI
  • contains incomplete instructions even for Cypress 9.x
  • package.json and package-lock.json are not aligned
  • is archived

Suggestion

In https://github.com/cypress-io/cypress-documentation/blob/main/docs/guides/guides/command-line.mdx https://github.com/cypress-io/cypress-documentation/blob/main/docs/app/references/command-line.mdx:

  1. Remove the references to the archived, legacy https://github.com/cypress-io/cypress-test-nested-projects repo
  2. Replace by an explanation of the --project option

Possibly this could be aligned to the explanation of cypress open --global which says:

Opening Cypress in global mode is useful if you have multiple nested projects but want to share a single global installation of Cypress. In this case you can add each nested project to the Cypress in global mode, thus giving you a nice UI to switch between them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    content: rewritetriagedIssue has been routed to backlog. This is not a commitment to have it prioritized by the team.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions