bigtreetech / bigtreetech/PandaTouch

Can't update firmware, docs not detailed enough, instructions not detailed enough, repo layout issues

Open
#334 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
265
Forks
63
PR merge metrics
No merged PRs in 30d

Description

Docs say latest update is 1.0.7 series, specifically on [L637 that states 1.0.7.1](https://github.com/bigtreetech/docs/blame/master/docs/Panda%20Touch.md#L637)
Latest release via the repo is [1.0.7.3](https://github.com/bigtreetech/PandaTouch/releases/tag/release%2Fv1.0.7.3) and is tagged as such.

Upon downloading the latest release zip AND trying a raw download of the specified files, they do not work. The latest I am able to update to is 1.0.6 "fat" which I will lay out below.

Ultimately my confidence as a end user is low that you've tested

## Issues
1. Docs do not explicitly state (root docs which deploy to WIKI) which img or bin file to use and in which order. It leaves much to interpretation which is not ideal as a naming convention deviation exists... (see more on that below).
2. Nonetheless, no file combination works in any directory except for [fat_panda_touch_v1.0.6.img](https://github.com/bigtreetech/PandaTouch/blob/master/Firmware/1.0.6.3/fat_panda_touch-v1.0.6.img) on the v1.0.6 directory
3. additional clarifications required as file naming has changed since v1.0.6, with the `fat` nomenclature
4. also note there is a `en_zh` where as newer firmware directories list `en-GB`, so some clarifications on the language translation should exist

## Recommendations
1. settle on recommended naming standard for img, bin, and language variants
2. document within each firmware folder if necessary installation instructions as they've deviated

**OR** simply use branches and keep master the current release. This means you will not have multiple directories, just the current firmware. Users can use the tag dropdown, releases feature, or git pull the appropriate tag for their respective release.

3. validate the img/bin combination files and ultimately update the docs and users how to update
4. update the docs/wiki deployment with the above

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.