Skip to content

Commit

Permalink
docs(app): include all present content in user instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tamslo committed Jan 30, 2025
1 parent 670f947 commit e497623
Show file tree
Hide file tree
Showing 2 changed files with 366 additions and 104 deletions.
10 changes: 10 additions & 0 deletions app/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ _supported._
_Check `e60efb4f2fc3ba2efa7735ffb06ec5fdb64d7af6` for a rudimentary script_
_version, removed afterwards due to too many merge conflicts._

## User Instructions

Currently, the user instructions are a static HTML file that need to be updated
manually if changes in the app content occur (at least the screenshots are
linked and do not need to be updated after re-generation).

We decided to host a PDF of the user instructions (for the study). To create
this PDF, open the HTML file in a browser (tested with Chrome) and print with
"Save to PDF".

## Adapting test data

If you would like to test with specific test data but you don't have a user with
Expand Down
Loading

0 comments on commit e497623

Please sign in to comment.