search

tahiri-lab / aPhyloGeo

aPhyloGeo is a multiplatform application for the analysis of genetic and climatic conditions.
https://pypi.org/project/aphylogeo/
GNU General Public License v3.0
10 stars 6 forks source link

Link explicitely to the wiki sections #39

Closed annazhukova closed 3 months ago

annazhukova commented 4 months ago

Currently the main README file links to the wiki page which has sections such as "Getting Started" which links to the page itself. It also has a "Pages" menu on the right with more wiki sections (including Getting Started with more information), however this menu is a bit hard to notice. I would advise linking to different pages explicitely on the README.

mmore500 commented 4 months ago

I would also add that it would be helpful to link directly to the tutorials in the Tutorials section of the README

We provide several tutorials to help you get started with the package.

hazem-dev commented 3 months ago

Thank you both for your valuable suggestions. We have carefully considered your feedback and have taken action to improve the documentation. As a result, we have added a new section titled 'Useful Links' in the README. This section aims to provide additional resources and references that can assist users in better understanding and utilizing the aPhyloGeo tool.

annazhukova commented 3 months ago

Thank you for adding 'Useful links', they are really useful!

It is a minor thing but I still find it a bit confusing to have

To begin using aPhyloGeo, refer to the official documentation for detailed instructions and usage guidelines.

where the official docunentation links to the page itself (https://github.com/tahiri-lab/aPhyloGeo/wiki) and not any other page. Maybe you could just write something like "Look at the widget on the right for various pages"