docs: fix README Examples issues

MikeMcC399 commented 1 month ago

Issues

In the README > Examples section ...

The first paragraph
- is not referring to examples, so it is misplaced in this section
- misleadingly says you need to install Cypress which is not true for cypress/included
The link to Check out our docs for examples. links to https://on.cypress.io/docker where there are no examples to be found.
The following paragraph refers to an outdated legacy blog (see also PR https://github.com/cypress-io/cypress-docker-images/pull/1070):

If you want to use the cypress/included image, read Run Cypress with a single Docker command
The set of 4 examples in the examples directory are based on cypress/included:3.8.0. This is a legacy version and the Cypress Docker images were generated before the introduction of cypress/factory. The issues, that the examples set out to address, take on a different form under non-legacy (current) versions of cypress/included:13.x generated through the cypress/factory process.
Providing only examples for cypress/included is unbalanced, when there are no examples listed for using cypress/base or cypress/browsers.

In the README > Examples section ...

Remove the first three paragraphs.
Replace with a link to the included/README.
Move the legacy examples/included* to the included/README and mark them as legacy for the time being.
Rework the included/README > Default user section and refer to the moved examples to avoid duplication.

cypress-app-bot commented 1 month ago

Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

MikeMcC399 commented 1 month ago

Preview