src/test/rustdoc-gui/README.md

   1 The tests present here are used to test the generated HTML from rustdoc. The
   2 goal is to prevent unsound/unexpected GUI changes.
   3
   4 This is using the [browser-ui-test] framework to do so. It works as follows:
   5
   6 It wraps [puppeteer] to send commands to a web browser in order to navigate and
   7 test what's being currently displayed in the web page.
   8
   9 You can find more information and its documentation in its [repository][browser-ui-test].
  10
  11 [browser-ui-test]: https://github.com/GuillaumeGomez/browser-UI-test/
  12 [puppeteer]: https://pptr.dev/