Add documentation for 4 new apps: Crypto, Stocks, Weather, and WiFi #5
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for four new utility apps (WiFi Settings, Weather, Stock Tracker, and Crypto Tracker) that provide network connectivity and data tracking capabilities for the Badger 2350. The documentation follows the established MDX format and includes installation instructions, configuration guidance, and troubleshooting information.
Key Changes
- Four new app documentation files with consistent structure and formatting
- Four corresponding PNG icon files for the app launcher
- Comprehensive feature descriptions, installation guides, and troubleshooting sections
Reviewed Changes
Copilot reviewed 4 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/apps/wifi.mdx | Documentation for WiFi Settings utility app for managing network connections |
| src/content/apps/weather.mdx | Documentation for Weather app with auto-location detection and real-time data |
| src/content/apps/stocks.mdx | Documentation for Stock Tracker app monitoring market prices |
| src/content/apps/crypto.mdx | Documentation for Crypto Tracker app displaying cryptocurrency prices |
| public/images/apps/wifi.png | App icon for WiFi Settings launcher |
| public/images/apps/weather.png | App icon for Weather launcher |
| public/images/apps/stocks.png | App icon for Stock Tracker launcher |
| public/images/apps/crypto.png | App icon for Crypto Tracker launcher |
|
|
||
| ## Controls | ||
|
|
||
| - **B Button**: Manually refresh weather data |
There was a problem hiding this comment.
Button control labels should use monospace font (font-mono) styling. Based on the hacker aesthetic guidelines, interactive controls and labels should use monospace typography. Consider structuring button labels consistently with the technical UI approach, e.g., 'B: Refresh weather data' or using a code-style format.
|
|
||
| ## Controls | ||
|
|
||
| - **B Button**: Manually refresh stock prices |
There was a problem hiding this comment.
Button control labels should use monospace font (font-mono) styling. Based on the hacker aesthetic guidelines, interactive controls and labels should use monospace typography. Consider structuring button labels consistently with the technical UI approach, e.g., 'B: Refresh prices' or using a code-style format.
|
|
||
| ## Controls | ||
|
|
||
| - **B Button**: Manually refresh cryptocurrency prices |
There was a problem hiding this comment.
Button control labels should use monospace font (font-mono) styling. Based on the hacker aesthetic guidelines, interactive controls and labels should use monospace typography. Consider structuring button labels consistently with the technical UI approach, e.g., 'B: Refresh prices' or using a code-style format.
| - **Auto-Connect**: Automatically attempts to connect to configured network | ||
| - **Retry Logic**: Smart retry with 15-second delays after failed attempts | ||
| - **Status Indicators**: Color-coded connection status (green=connected, red=failed) | ||
| - **Configuration Helper**: Guides you to edit settings via USB mode |
There was a problem hiding this comment.
The term 'USB mode' is inconsistent with terminology used elsewhere in documentation. Other docs use 'USB storage mode' (line 43) or 'USB disk mode'. Consider using the consistent term 'USB storage mode' throughout.
| - **Configuration Helper**: Guides you to edit settings via USB mode | |
| - **Configuration Helper**: Guides you to edit settings via USB storage mode |
| - **Auto-Refresh**: Updates weather data every 60 seconds | ||
| - **Manual Refresh**: Press B button to refresh weather on demand | ||
| - **WiFi Integration**: Connects using credentials from `/secrets.py` | ||
| - **Clean Display**: GitHub-themed interface with color-coded weather info |
There was a problem hiding this comment.
The phrase 'GitHub-themed interface' uses marketing/branding language. According to the hacker aesthetic guidelines, avoid corporate terminology. Consider using technical descriptions like 'Dark terminal-inspired UI with color-coded status' or 'Monochrome interface with green accent indicators'.
| - **Auto-Refresh**: Automatically updates prices every 60 seconds | ||
| - **Manual Refresh**: Press B button to refresh prices on demand | ||
| - **WiFi Integration**: Connects using credentials from `/secrets.py` | ||
| - **Market-Ready UI**: Clean GitHub-themed interface with professional stock display |
There was a problem hiding this comment.
The phrases 'Market-Ready UI', 'Clean', and 'professional' use marketing language. According to the hacker aesthetic guidelines, avoid sales/marketing terminology and corporate sheen. Consider technical descriptions like 'Dark UI with monospace price display' or 'Terminal-style market data interface'.
| - **Auto-Refresh**: Automatically updates prices every 60 seconds | ||
| - **Manual Refresh**: Press B button to refresh prices on demand | ||
| - **WiFi Integration**: Connects to WiFi using credentials from `/secrets.py` | ||
| - **Clean UI**: GitHub-themed dark interface with color-coded price movements |
There was a problem hiding this comment.
The phrase 'Clean UI' and 'GitHub-themed' use marketing/branding language. According to the hacker aesthetic guidelines, avoid corporate terminology. Consider using technical descriptions like 'Dark monospace interface with color-coded movements' or 'Terminal-style price display'.
1 participant
Summary
This PR adds documentation pages for 4 new utility apps submitted to the badge apps repository.
Documentation Added
Files Added
src/content/apps/public/images/apps/Related
This documentation corresponds to the apps submitted in badger/home PR #34