Improve documentation for launching ASReview #1625
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rensvandeschoot
changed the title
J535D165
reviewed
Jan 4, 2024
Comment on lines
-11
to
-12
| When you are using Windows, open `CMD.exe` and run the command. When you use | ||
| MacOS or Linux, you can open `Terminal` and run the command. |
There was a problem hiding this comment.
Some users report issues here. They don't open the command line, but open Python. It might be worth integrating this part of the text with lines 4-5 (and keeping the new changes as well).
There was a problem hiding this comment.
I added more details (both for installing and starting ASReview) to avoid users to open Python. Should we explicitly state they should not open Python?
I also added a hyperlink to our online and free teaching materials which includes screenshots.
|
Unintendedly closed because of branch renaming. I will work on fixing this. |
|
Re-opened in #1648 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on users' feedback I updated the launching of ASReview LAB (it starts automatically in the default browser) and I added a screenshot of the project dashboard.