message: add docs for how to run cypress tests
diff: @@ -40,6 +40,22 @@ yarn start
  yarn techdocs-cli:dev [...options]
  ```
  +### Use an example docs project
  +
  +We have created an [example documentation project](https://github.com/backstage/techdocs-container/tree/main/mock-docs) and it's shipped with [techdocs-container](https://github.com/backstage/techdocs-container) repository, for the purpose of local development. But you are free to create your own local test site. All it takes is a `docs/index.md` and `mkdocs.yml` in a directory.
  +
  +```sh
  +git clone https://github.com/backstage/techdocs-container.git
  +
  +cd techdocs-container/mock-docs
  +
  +# To get a view of your docs in Backstage, use:
  +techdocs-cli serve
  +
  +# To view the raw mkdocs site (without Backstage), use:
  +techdocs-cli serve:mkdocs
  +```
  +
  ### Testing
  Running unit tests requires mkdocs to be installed locally:
  @@ -51,18 +67,32 @@ pip install mkdocs-techdocs-core
  Then run `yarn test`.
  -### Use an example docs project
  +#### Run Cypress tests
  -We have created an [example documentation project](https://github.com/backstage/techdocs-container/tree/main/mock-docs) and it's shipped with [techdocs-container](https://github.com/backstage/techdocs-container) repository, for the purpose of local development. But you are free to create your own local test site. All it takes is a `docs/index.md` and `mkdocs.yml` in a directory.
  +Running cypress tests requires you to run the CLI locally against our example docs project
  +
  +Start by making sure you have the example project locally on your computer
  ```sh
  git clone https://github.com/backstage/techdocs-container.git
  +```
  +
  +Run the local version of techdocs-cli against the example docs project
  +
  +```sh
  +# From the root of this repository run
  +# NOTE: This will build the techdocs-cli-embedded-app and copy the output into the cli dist directory
  +yarn build --scope @techdocs/cli
  +# Navigate to the example project
  cd techdocs-container/mock-docs
  -# To get a view of your docs in Backstage, use:
  -techdocs-cli serve
  +# Now execute the techdocs-cli binary
  +../../backstage/packages/techdocs-cli/bin/techdocs-cli
  +```
  -# To view the raw mkdocs site (without Backstage), use:
  -techdocs-cli serve:mkdocs
  +Run the cypress tests
  +
  +```sh
  +yarn cypress:open
  ```
  