edouard.paris / crosspoint-reader
A fork of https://github.com/crosspoint-reader/crosspoint-reader
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: Updating webserver.md documentation to align with 1.0.0 features (#906)

## Summary

* **What is the goal of this PR?** (e.g., Implements the new feature for
file uploading.)

Updating webserver.md documentation to align with 1.0.0 features

* **What changes are included?**

Added documentation for the following new features (including replacing
screenshots)

- file renaming
- file moving
- support for uploading any file type
- batch uploads

## Additional Context

* Add any other information that might be helpful for the reviewer
(e.g., performance implications, potential risks,
specific areas to focus on).

Nothing comes to mind

---

### AI Usage

While CrossPoint doesn't have restrictions on AI tools in contributing,
please be transparent about their usage as it
helps set the right context for reviewers.

Did you use AI tools to help write this code? _**NO**_

authored by

Lev Roland-Kalb and committed by
GitHub 5c80cfac 86d3774a

+32 -22
docs/images/wifi/webserver_files.png

This is a binary file and will not be displayed.

docs/images/wifi/webserver_upload.png

This is a binary file and will not be displayed.

+32 -22
docs/webserver.md
··· 1 1 # Web Server Guide 2 2 3 - This guide explains how to connect your CrossPoint Reader to WiFi and use the built-in web server to upload EPUB files from your computer or phone. 3 + This guide explains how to connect your CrossPoint Reader to WiFi and use the built-in web server to upload files from your computer or phone. 4 4 5 5 ## Overview 6 6 7 7 CrossPoint Reader includes a built-in web server that allows you to: 8 8 9 - - Upload EPUB files wirelessly from any device on the same WiFi network 9 + - Upload files wirelessly from any device on the same WiFi network 10 10 - Browse and manage files on your device's SD card 11 - - Create folders to organize your ebooks 11 + - Create folders to organize your library 12 12 - Delete files and folders 13 13 14 14 ## Prerequisites ··· 129 129 #### Browsing Files 130 130 131 131 - The file manager displays all files and folders on your SD card 132 - - **Folders** are highlighted in yellow with a 📁 icon 133 - - **EPUB files** are highlighted in green with a 📗 icon 132 + - **Folders** are highlighted in yellow and indicated with a 📁 icon 133 + - **EPUB Files** are highlighted in green and indicated with a 📗 icon 134 + - **All Other Files** are not highlighted and indicated with a 📄 icon 134 135 - Click on a folder name to navigate into it 135 136 - Use the breadcrumb navigation at the top to go back to parent folders 136 137 137 138 <img src="./images/wifi/webserver_files.png" width="600"> 138 139 139 - #### Uploading EPUB Files 140 - 141 - 1. Click the **+ Add** button in the top-right corner 142 - 2. Select **Upload eBook** from the dropdown menu 143 - 3. Click **Choose File** and select an `.epub` file from your device 144 - 4. Click **Upload** 145 - 5. A progress bar will show the upload status 146 - 6. The page will automatically refresh when the upload is complete 140 + #### Uploading Files 147 141 148 - **Note:** Only `.epub` files are accepted. Other file types will be rejected. 142 + 1. Click the **📤 Upload** button in the top-right corner 143 + 2. Click **Choose File** and select a file from your device 144 + 3. Click **Upload** 145 + 4. A progress bar will show the upload status 146 + 5. The page will automatically refresh when the upload is complete 149 147 150 148 <img src="./images/wifi/webserver_upload.png" width="600"> 151 149 152 150 #### Creating Folders 153 151 154 - 1. Click the **+ Add** button in the top-right corner 155 - 2. Select **New Folder** from the dropdown menu 156 - 3. Enter a folder name (must not contain characters \" * : < > ? / \\ | and must not be . or ..) 157 - 4. Click **Create Folder** 152 + 1. Click the **📁 New Folder** button in the top-right corner 153 + 2. Enter a folder name (must not contain characters \" * : < > ? / \\ | and must not be . or ..) 154 + 3. Click **Create Folder** 158 155 159 - This is useful for organizing your ebooks by genre, author, or series. 156 + This is useful for organizing your library by genre, author, series or file type. 160 157 161 158 #### Deleting Files and Folders 162 159 ··· 168 165 169 166 **Note:** Folders must be empty before they can be deleted. 170 167 168 + #### Moving Files 169 + 170 + 1. Click the **📂** (folder) icon next to any file 171 + 2. Enter a folder name or select one from the dropdown 172 + 3. Click **Move** to relocate the file 173 + 174 + **Note:** Typing in a nonexistent folder name will result in the following error: "Failed to move: Destination not found" 175 + 176 + #### Renaming Files 177 + 178 + 1. Click the **✏️** (pencil) icon next to any file 179 + 2. Enter a file name (must not contain characters \" * : < > ? / \\ | and must not be . or ..) 180 + 3. Click **Rename** to permanently rename the file 181 + 171 182 --- 172 183 173 184 ## Command Line File Management 174 185 175 - For power users, you can manage files directly from your terminal using `curl` while the device is in File Upload mode a detailed documentation can be found [here](./webserver-endpoints.md). 186 + For power users, you can manage files directly from your terminal using `curl` while the device is in File Upload mode. Detailed documentation can be found [here](./webserver-endpoints.md). 176 187 177 188 ## Security Notes 178 189 ··· 189 200 - **Supported WiFi:** 2.4GHz networks (802.11 b/g/n) 190 201 - **Web Server Port:** 80 (HTTP) 191 202 - **Maximum Upload Size:** Limited by available SD card space 192 - - **Supported File Format:** `.epub` only 193 203 - **Browser Compatibility:** All modern browsers (Chrome, Firefox, Safari, Edge) 194 204 195 205 --- ··· 198 208 199 209 1. **Organize with folders** - Create folders before uploading to keep your library organized 200 210 2. **Check signal strength** - Stronger signals (`|||` or `||||`) provide faster, more reliable uploads 201 - 3. **Upload multiple files** - You can upload files one at a time; the page refreshes after each upload 211 + 3. **Upload multiple files** - You can select and upload multiple files at once; the manager will queue them and refresh when the batch is finished 202 212 4. **Use descriptive names** - Name your folders clearly (e.g., "SciFi", "Mystery", "Non-Fiction") 203 213 5. **Keep credentials saved** - Save your WiFi password for quick reconnection in the future 204 214 6. **Exit when done** - Press **Back** to exit the WiFi screen and save battery