Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use browser tests to screenshot the most important use cases #2719

Open
4 tasks
Macroz opened this issue Sep 10, 2021 · 0 comments
Open
4 tasks

Use browser tests to screenshot the most important use cases #2719

Macroz opened this issue Sep 10, 2021 · 0 comments
Labels
Documentation Epic Too big, should be split Feature It's intentionally in the project Hacktoberfest
Milestone

Comments

@Macroz
Copy link
Collaborator

Macroz commented Sep 10, 2021

We can use use browser tests to screenshot the most important use cases and add that as automatic documentation.

It would be nice to do even a small part of these ideas. This ticket can be split also.

  • As a first step let's just make sure the screenshots from a whole pass of browser tests are valid and output the best and most descriptive ones to somewhere like /docs/screenshots folder.
  • The names of the screenshots should be relevant (the current naming is ok for test debugging but we can make a new copy for each sensible image with a descriptive and relevant name. Sequence numbers could be useful to order the screenshots.
  • Consider saving a separate Markdown file that links to the screenshots or use plain folder view of GitHub.
  • Consider if we could have the screenshots from /manual be automated. Perhaps with some or no markings on the screenshots.
@Macroz Macroz created this issue from a note in Rems task board (Ideas) Sep 10, 2021
@Macroz Macroz added Feature It's intentionally in the project Hacktoberfest Documentation Epic Too big, should be split labels Sep 10, 2021
@Macroz Macroz added this to the UI Refresh milestone Mar 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Epic Too big, should be split Feature It's intentionally in the project Hacktoberfest
Projects
Development

No branches or pull requests

1 participant