Improve documentation

Author: marcelstoer

.gitignore

@@ -1,3 +1,4 @@
+.idea
 .pio
 .vscode
 src/compile_time.h

README.md

@@ -34,7 +34,7 @@ In order to run this project on your device, you will need to setup an applicati
  ## Features
 
 - **Spotify Playback Control**
-  - Play, pause, skip to next/previous track from the touch screen
+  - Play, pause, skip to next/previous track from the touch screen. ⚠️ Spotify requires a premium account for this!
   - Control playback on any active Spotify Connect device linked to your account (e.g., phone, browser, smart speaker)
 
 - **Album Art Display**
@@ -75,7 +75,7 @@ In order to run this project on your device, you will need to setup an applicati
 - Tap the **album art** on the Home view to switch to the **Cover Art view**.
 - Tap the **clock** to switch to the **Clock view**.
 - Tap the **network status box** in the lower-right corner to open the **Diagnostics view**.
-- Tap the top-left corner for **Prev**, the top-center for **Pause/Play**, and the top-right for **Next** when using views other than Home. 
+- Tap the top-left corner for **Prev**, the top-center for **Pause/Play**, and the top-right for **Next** when using views other than Home.
 
 > For detailed display logic and diagnostics layout, see `DiagnosticsView.cpp`.
 
@@ -143,4 +143,4 @@ See [instructions](https://docs.thingpulse.com/guides/esp32-color-kit-grande/#de
 
 ## Tips and Known Issues
 
-To see a list of tips and known issues, see [Tips and Known Issues](./documentation/TipsAndKnownIssues.md).
+To see a list of tips and known issues, see [Tips and Known Issues](./documentation/TipsAndKnownIssues.md).

documentation/TipsAndKnownIssues.md

@@ -1,5 +1,6 @@
 # Tips
-- To surpress logging from the SpotifyAruduion library, goto the `SpotifyArduino.h` and commend out the following lines: 
+- To suppress logging from the [SpotifyArduino library](https://github.com/witnessmenow/spotify-api-arduino/), go to its `SpotifyArduino.h` in `.pio/libdeps/thingpulse-color-kit-grande/SpotifyArduino/src` and commend out the following lines:
+
 ```
 #define SPOTIFY_DEBUG 1
 
@@ -10,22 +11,30 @@
 #define SPOTIFY_PRINT_JSON_PARSE 1
 ```
 
-- If you have a Color Kit Grande with 8 MB or more of Flash memory, you can expand the album art cache from 10 albums to 60 albums by using these settings in `platformio.ini`.  See the file for additional comments.
+- If you have an ESP32 Wrover-B with 8 MB or more of Flash memory, you can expand the album art cache from 10 albums to 60 albums by using these settings in `platformio.ini`.
+See the file for additional comments.
+
 ```
 board = custom_esp-wrover-kit
 board_build.partitions = partitions/custom_no_ota.csv
 ```
 
-- If you want to update your WiFi and Spotify credentials without modifying the source code, use the optional `user.ini` file.  The file is ignored by Git and does not require changing code. See [full user settings documentation](./UserSettings.md) for details.
+- If you want to update your WiFi and Spotify credentials without modifying the source code, use the optional `user.ini` file.
+The file is ignored by Git and does not require changing code.
+See [full user settings documentation](./UserSettings.md) for details.
 
 # Known Issues
-- Some capabilities require a Spotify Premium subscription and may not work fully on the ad supported tier. https://developer.spotify.com/documentation/web-playback-sdk
+- Some capabilities such as the player controls (stop, start, skip, etc.) require a Spotify Premium subscription and may not work on the ad-supported tier.
+See the [Spotify API documentation](https://developer.spotify.com/documentation/web-playback-sdk) for details.
 
-- At startup if nothing is playing the following may be logged repeatedly:
+- At startup if nothing is playing, the following may be logged repeatedly:
 `20:13:34.148 > [ 15318][E][ssl_client.cpp:37] _handle_error(): [data_to_read():361]: (-76) UNKNOWN ERROR CODE (004C)`
-When there isn't currently an active device or a device has been stopped for a period of time, playback controls may not work and these errors may be seen in the logs.  Once music is started/resumed on the active device the errors will go away.
+While there is no currently active device or a device has been stopped for a period of time, playback controls may not work and these errors may be seen in the logs.
+Once music is started/resumed on the active device, the errors will go away.
+
+- When playback operations are performed, the SpotifyArduino library may log the following.
+It does not appear to affect the operation from actually working.
 
-- When playback operations are performed, the SpotifyArdiuno library may log the following. It doesn't appear to affect the operation from actually working.
 ```
 23:24:36.283 > [ 67244][V][ssl_client.cpp:369] send_ssl_data(): Writing HTTP request with 0 bytes...
 23:24:36.440 > [ 67407][V][ssl_client.cpp:381] send_ssl_data(): Handling error -80