search

luc-github / esp3d.io

Documentation of ESP3D Ecosystem
GNU General Public License v3.0
6 stars 21 forks source link

[BUG] Wrong link in documentation #14

Closed probonopd closed 1 year ago

probonopd commented 1 year ago

Describe the bug

http://esp3d.io/esp3d-webui/v3.x/installation/index.html links to 2.x versions of the ESP3D-WEBUI.

The Web UI is represented by one file : index.hml.gz The full package with all languages is available here But it may not fit your available size on flash, so you can select a single language package here which is lighter and will fit smallest boards.

If one uploads this, then one gets the error Otherwise it says "Connection failed! Is your FW correct?". It is not clear to the user what "connection" failed. The connection between what and what? This cost me hours trying to debug the connection between the 3D printer and the ESP32-CAM when in fact the issue was just caused by a wrong version of the ESP3D-WEBUI. The error message could be clearer.

To Reproduce Steps to reproduce the behavior:

  1. Go to http://esp3d.io/esp3d-webui/v3.x/installation/index.html
  2. Follow the links to index.html.gz

Expected behavior

The 3.x documentation links to version 3.x of the index.html.gz

https://github.com/luc-github/ESP3D-WEBUI/blob/3.0/dist/Printer3D/Marlin/index.html.gz

github-actions[bot] commented 1 year ago

Thank your for submiting, please be sure you followed template or your issue may be dismissed.

probonopd commented 1 year ago

I used the portions of the template that are applicable, so I hope it is ok.

luc-github commented 1 year ago

Text modified, site updated - thank you for pointing this, it was unmodified copy and past of 2.X doc

If one uploads this, then one gets the error Otherwise it says "Connection failed! Is your FW correct?"

Error is correct the web ui seems not matching the FW, but it is light because I do not want to add a lot of text on something that should not happen that would add translation needs

So to avoid that, I plan to add a link in error message to to troubleshooting documentation but currently there is not such thing - I am not good in documentation mostly because most of the time, even documentation is present people do not read it... orz, so I do not spend time on it