Skip to content

Commit c11f20d

Browse files
committed
Update documentation and release workflow
Improve compatibility information and workflow configuration.
1 parent 7d53571 commit c11f20d

File tree

3 files changed

+32
-1
lines changed

3 files changed

+32
-1
lines changed

.github/workflows/pre_release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
updateOnlyUnreleased: true
7070
generateReleaseNotes: true
7171
prerelease: true
72-
bodyFile: RELEASE
72+
bodyFile: RELEASE.md
7373
artifacts: "U1_*.bin"
7474

7575
- name: Save Firmwares Cache

docs/data_persistence.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,16 @@ rm /oem/.debug
2222
## Printer Data
2323

2424
The `/home/lava/printer_data` directory persists with and without `/oem/.debug`.
25+
26+
## ⚠️ Important Warning
27+
28+
**Enabling data persistence may break firmware functionality when performing system upgrades.**
29+
30+
It is strongly advised to remove persistence before conducting any firmware upgrade to avoid compatibility issues. To do this:
31+
32+
```bash
33+
rm /oem/.debug
34+
reboot
35+
```
36+
37+
After the firmware upgrade is complete, you can re-enable persistence if needed by recreating the file.

docs/usb_ethernet.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,21 @@ The custom firmware includes hot-plug support for USB ethernet adapters.
1414

1515
Simply plug in a USB ethernet adapter to the printer's USB port.
1616
The adapter will be automatically detected and configured with DHCP.
17+
18+
## Adapter Compatibility
19+
20+
Support for USB ethernet adapters may vary depending on the chipset. The following have been tested and confirmed working:
21+
22+
- **100M Realtek adapters**: Confirmed working
23+
- **2.5Gbps adapters**: Confirmed working
24+
25+
### Reporting Compatibility Issues
26+
27+
If you encounter issues with your USB ethernet adapter, please share the USB IDs to help improve compatibility documentation. You can retrieve this information via SSH using:
28+
29+
```bash
30+
lsusb
31+
lsusb -t
32+
```
33+
34+
Please report any non-working adapters along with their USB IDs on the GitHub issues page.

0 commit comments

Comments
 (0)