Sarc-Graph / sarcgraph

MIT License
2 stars 2 forks source link

[JOSS Review] Documentation #7

Closed mbarzegary closed 1 year ago

mbarzegary commented 1 year ago

Dear authors,

The documentation is quite acceptable for JOSS in my opinion, and it is written well. However, you may consider improving it with these suggestions:

P.S. This issue is related to https://github.com/openjournals/joss-reviews/issues/5322

saeedmhz commented 1 year ago

Thank you for your valuable feedback on our paper. We appreciate your suggestions regarding the documentation, and we have made some changes accordingly.

We have addressed the issue you mentioned regarding the installation guide in the repo readme file and the hosted documentation by making sure they match. You can find more information about this in our response to Sarc-Graph/sarcgraph#3.

Additionally, we have removed all the $ signs from the provided commands in the installation guide, making it easier for users to copy and run the commands.