search

elisa-tech / meta-elisa

MIT License
9 stars 16 forks source link

Add the link to the wiki and troubleshooting page to the readme.md #26

Closed pahmann closed 1 year ago

pahmann commented 2 years ago

The readme should mention that there is a wiki to collect trouble shooting issues.

pahmann commented 1 year ago

There is a troubleshooting page existing for the meta-elisa demonstrator. It can be found at https://github.com/elisa-tech/meta-elisa/wiki/Troubleshooting.

It is not logical to find the page and be aware of the existence. For this reason it should be added to the README.

Information should be added in a new section "Troubleshooting" above https://github.com/elisa-tech/meta-elisa/#contributing with the following content: "There is a Troubleshooting wiki page in this repo listing known warnings and potential hurdles when interacting with the demo. The provided information enhances the documentation. As it will not impact majority of users, they are listed there outside of the formal meta-elisa repo. If you face any issue or bug not listed there, consider to create a new issue."

pahmann commented 1 year ago

@LeandraVoges added the necessary documentation, so this issue can be closed.