Skip to content

Commit 49ee2af

Browse files
committed
fix(widgets): remove weather and news widgets documentation [need ci]
- Deleted detailed descriptions, features, config options, and data structures for weather and news widgets - Updated project overview to remove references to these widgets - Adjusted roadmap to skip implementation of additional widgets like clock and calendar - Synchronized documentation changes in English and Russian versions
1 parent fa20a49 commit 49ee2af

File tree

6 files changed

+10
-140
lines changed

6 files changed

+10
-140
lines changed

PROJECT_OVERVIEW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ v
149149
- ✅ Implementation of Habits Tracking Widget
150150
- ✅ Widget configuration interface
151151
- ✅ Widget grid positioning
152-
- ✅ Multiple widget types (clock, calendar, habits tracking, weather, news, etc.)
152+
- ✅ Multiple widget types (clock, calendar, habits tracking)
153153

154154
4. **Mobile Application**
155155
- ✅ QR code scanning functionality

PROJECT_OVERVIEW_RU.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ v
149149
- ✅ Реализация виджета отслеживания привычек
150150
- ✅ Интерфейс конфигурации виджетов
151151
- ✅ Позиционирование виджетов в сетке
152-
- ✅ Несколько типов виджетов (часы, календарь, отслеживание привычек, погода, новости и т.д.)
152+
- ✅ Несколько типов виджетов (часы, календарь, отслеживание привычек)
153153

154154
4. **Мобильное приложение**
155155
- ✅ Функциональность сканирования QR-кода

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is a comprehensive dashboard management system for displaying information o
88
- Mobile application for displaying widgets on Android phones
99
- QR code based device binding
1010
- Real-time widget updates
11-
- Support for multiple widget types (clock, calendar, habits tracking, etc.)
11+
- Support for multiple widget types (clock, calendar, habits tracking)
1212
- Anonymous user mode
1313
- Telegram authentication
1414
- Dark/light theme support

README_RU.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- Мобильное приложение для отображения виджетов на Android-устройствах
99
- Привязка устройств через QR-код
1010
- Обновление виджетов в реальном времени
11-
- Поддержка нескольких типов виджетов (часы, календарь, отслеживание привычек и т.д.)
11+
- Поддержка нескольких типов виджетов (часы, календарь, отслеживание привычек)
1212
- Анонимный режим пользователя
1313
- Аутентификация через Telegram
1414
- Поддержка темной/светлой темы

web/WIDGETS_DOCUMENTATION.md

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -178,79 +178,14 @@ interface CalendarWidgetOptions {
178178
}
179179
```
180180

181-
### Weather Widget
182181

183-
The Weather Widget displays current weather information based on location.
184-
185-
#### Widget Features:
186-
187-
1. **Dashboard Display**:
188-
- Current temperature
189-
- Weather conditions (sunny, cloudy, rainy, etc.)
190-
- Location information
191-
- High and low temperatures
192-
193-
2. **Configuration Options**:
194-
- Location selection
195-
- Temperature unit (Celsius/Fahrenheit)
196-
- Weather service API key
197-
198-
#### Technical Implementation:
199-
200-
##### Implementation Files:
201-
- `web/src/server/widgets/weather-widget.ts` - Main widget class and display template
202-
- `web/src/server/widgets/weather-widget.utils.ts` - Client-side helper functions
203-
204-
##### Data Structure:
205-
```typescript
206-
interface WeatherWidgetOptions {
207-
location: string;
208-
unit: 'celsius' | 'fahrenheit';
209-
apiKey: string;
210-
}
211-
```
212-
213-
### News Widget
214-
215-
The News Widget displays latest news headlines based on category or source.
216-
217-
#### Widget Features:
218-
219-
1. **Dashboard Display**:
220-
- Top news headlines
221-
- News source information
222-
- Publication time
223-
- News categories
224-
225-
2. **Configuration Options**:
226-
- News category selection
227-
- News source selection
228-
- Number of articles to display
229-
- Auto-refresh interval
230-
231-
#### Technical Implementation:
232-
233-
##### Implementation Files:
234-
- `web/src/server/widgets/news-widget.ts` - Main widget class and display template
235-
- `web/src/server/widgets/news-widget.utils.ts` - Client-side helper functions
236-
237-
##### Data Structure:
238-
```typescript
239-
interface NewsWidgetOptions {
240-
category: string;
241-
source: string;
242-
maxArticles: number;
243-
refreshInterval: number;
244-
}
245-
```
246182

247183
## Widgets Development Roadmap
248184

249185
### Near-term Tasks:
250-
1. Implementation of additional widgets (clock, calendar)
251-
2. Improvement of widget configuration system
252-
3. Adding ability to save widget states in the database
253-
4. Implementation of widget change logging system
186+
1. Improvement of widget configuration system
187+
2. Adding ability to save widget states in the database
188+
3. Implementation of widget change logging system
254189

255190
### Long-term Goals:
256191
1. Creation of an extensible widget system with ability to add new types

web/WIDGETS_DOCUMENTATION_RU.md

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -182,80 +182,15 @@ interface CalendarWidgetOptions {
182182
}
183183
```
184184

185-
### Виджет погоды (Weather Widget)
186185

187-
Виджет погоды отображает текущую информацию о погоде на основе местоположения.
188-
189-
#### Особенности виджета:
190-
191-
1. **Отображение на дашборде**:
192-
- Текущая температура
193-
- Погодные условия (солнечно, облачно, дождливо и т.д.)
194-
- Информация о местоположении
195-
- Максимальная и минимальная температура
196-
197-
2. **Параметры настройки**:
198-
- Выбор местоположения
199-
- Единица измерения температуры (Цельсий/Фаренгейт)
200-
- Ключ API службы погоды
201-
202-
#### Техническая реализация:
203-
204-
##### Файлы реализации:
205-
- `web/src/server/widgets/weather-widget.ts` - Основной класс виджета и шаблон отображения
206-
- `web/src/server/widgets/weather-widget.utils.ts` - Вспомогательные функции на стороне клиента
207-
208-
##### Структура данных:
209-
```typescript
210-
interface WeatherWidgetOptions {
211-
location: string;
212-
unit: 'celsius' | 'fahrenheit';
213-
apiKey: string;
214-
}
215-
```
216-
217-
### Виджет новостей (News Widget)
218-
219-
Виджет новостей отображает последние заголовки новостей на основе категории или источника.
220-
221-
#### Особенности виджета:
222-
223-
1. **Отображение на дашборде**:
224-
- Заголовки главных новостей
225-
- Информация об источнике новостей
226-
- Время публикации
227-
- Категории новостей
228-
229-
2. **Параметры настройки**:
230-
- Выбор категории новостей
231-
- Выбор источника новостей
232-
- Количество отображаемых статей
233-
- Интервал автообновления
234-
235-
#### Техническая реализация:
236-
237-
##### Файлы реализации:
238-
- `web/src/server/widgets/news-widget.ts` - Основной класс виджета и шаблон отображения
239-
- `web/src/server/widgets/news-widget.utils.ts` - Вспомогательные функции на стороне клиента
240-
241-
##### Структура данных:
242-
```typescript
243-
interface NewsWidgetOptions {
244-
category: string;
245-
source: string;
246-
maxArticles: number;
247-
refreshInterval: number;
248-
}
249-
```
250186

251187
## План развития виджетов
252188

253189
### Ближайшие задачи:
254190

255-
1. Реализация дополнительных виджетов (часы, календарь)
256-
2. Улучшение системы настройки виджетов
257-
3. Добавление возможности сохранения состояния виджетов в базе данных
258-
4. Реализация системы логирования изменений виджетов
191+
1. Улучшение системы настройки виджетов
192+
2. Добавление возможности сохранения состояния виджетов в базе данных
193+
3. Реализация системы логирования изменений виджетов
259194

260195
### Долгосрочные цели:
261196

0 commit comments

Comments
 (0)