Update Web News documentation for enhanced clarity and features

- Revised the documentation for Web News to reflect its privacy-focused, offline-first capabilities and full-text extraction features. - Expanded the features section to include details on data sovereignty, anonymous access, and a hardened backend. - Updated build and run instructions, including prerequisites and server configuration options. - Added a comprehensive keyboard shortcuts section for improved user navigation.
2025-12-27 19:11:48 -06:00
parent d8748bba77
commit 212bebce86
4 changed files with 184 additions and 72 deletions
--- a/frontend/src/lib/docs/software/webnews.de.md
+++ b/frontend/src/lib/docs/software/webnews.de.md
@@ -1,33 +1,61 @@
-# WebNews
+# Web News

-WebNews ist ein leistungsstarker terminalbasierter Newsreader, der auf Einfachheit und Geschwindigkeit ausgelegt ist.
+Web News ist ein auf Privatsphäre ausgerichteter, offline-fähiger RSS-Reader und Volltext-Extraktor. Er kombiniert ein Svelte-basiertes reaktives Frontend mit einem leistungsstarken Go-basierten Backend und ist als eigenständiger Webserver oder als native Desktop-Anwendung verfügbar.
+
+[Quellcode](https://git.quad4.io/Quad4-Software/webnews)

 ## Funktionen

- **Blitzschnell**: In Go geschrieben für optimale Performance.
- **Vim-ähnliche Tastenkombinationen**: Vertraute Steuerung für Terminal-Power-User.
- **Offline-Unterstützung**: Artikel für das Lesen ohne Internetverbindung zwischenspeichern.
- **Anpassbare Themes**: Unterstützung für helle und dunkle Terminal-Farbschemata.
+- **Privatsphäre zuerst**: Kein Tracking, keine Konten und keine Cloud-Synchronisierung. Alle Daten verbleiben auf Ihrem lokalen Gerät.
+- **Offline zuerst**: Artikel, Feeds und Einstellungen werden lokal mit IndexedDB gespeichert, um einen nahtlosen Offline-Zugriff zu ermöglichen.
+- **Volltext-Extraktion**: Enthält einen speziellen "Lese-Modus", um mit einem Klick sauberen Inhalt von jeder URL zu extrahieren.
+- **Globale Suche**: Leistungsstarke Volltextsuche über Ihren gesamten Leseverlauf.
+- **Intelligenter Feed**: Lokal verarbeitetes, personalisiertes Ranking basierend auf Ihren Lesegewohnheiten.
+- **Vim-ähnliche Tastenkombinationen**: Effiziente Navigation mit vertrauten Tastatursteuerungen.
+- **Anpassbarer Reader**: Unterstützung für verschiedene Schriftarten (Serif/Sans), anpassbare Größen und Zeilenhöhen.

-## Installation
+## Privatsphäre und Sicherheit

-Sie können die neueste Binärdatei für Ihr Betriebssystem von der Hauptseite herunterladen.
+Web News basiert auf einer "Zero-Knowledge"-Philosophie, um sicherzustellen, dass Benutzerdaten privat bleiben:
+- **Datensouveränität**: Ihre Leseliste und Ihr Verlauf verlassen niemals Ihr Gerät.
+- **Anonymer Zugriff**: Verwendet 16-stellige Kontonummern für den Serverzugriff anstelle von persönlichen Identifikatoren.
+- **Gehärtetes Backend**: Verfügt über integriertes Bot-Blocking, Ratenbegrenzung und sichere Token-Generierung.
+
+## Erste Schritte
+
+### Voraussetzungen
+
+- Go 1.21 oder höher
+- Node.js 18 oder höher
+- pnpm 9 oder höher
+
+### Erstellen und Ausführen
+
+So erstellen und starten Sie den Webserver:

 ```bash
-# Beispielnutzung
-webnews --sync
+make build
+./bin/web-news
+```
+
+Für Desktop-Anwendungs-Builds (erfordert Wails CLI):
+
+```bash
+make desktop-build
 ```

 ## Konfiguration

-Die Konfiguration wird standardmäßig in `~/.config/webnews/config.yaml` gespeichert.
+Die Anwendung kann mit den folgenden Server-Flags konfiguriert werden:

-```yaml
-sources:
-  - https://hnrss.org/frontpage
-  - https://lobste.rs/rss
-```
+- `--auth-mode`: Festlegen auf `none`, `token` oder `multi`.
+- `--port`: Der Port, auf dem gelauscht werden soll (Standard ist `8080`).
+- `--allow-registration`: Aktivieren oder Deaktivieren der Generierung neuer Kontonummern.

---
+## Tastenkombinationen

-_Dies ist eine Test-Dokumentationsdatei, die aus Markdown gerendert wurde._
+- `j` / `k`: Zum nächsten oder vorherigen Artikel navigieren.
+- `r`: Den aktuellen Artikel als gelesen markieren.
+- `s`: Den gespeicherten Status eines Artikels umschalten.
+- `x`: Multi-Select-Modus umschalten.
+- `o`: Die ursprüngliche Artikel-URL öffnen.
--- a/frontend/src/lib/docs/software/webnews.it.md
+++ b/frontend/src/lib/docs/software/webnews.it.md
@@ -1,33 +1,61 @@
-# WebNews
+# Web News

-WebNews è un lettore di notizie basato su terminale ad alte prestazioni, progettato per semplicità e velocità.
+Web News è un lettore RSS orientato alla privacy, progettato per funzionare offline e con estrazione del testo completo. Combina un frontend reattivo basato su Svelte con un backend ad alte prestazioni in Go, disponibile come server web autonomo o come applicazione desktop nativa.
+
+[Codice Sorgente](https://git.quad4.io/Quad4-Software/webnews)

 ## Caratteristiche

- **Velocissimo**: Scritto in Go per prestazioni ottimali.
- **Scorciatoie in stile Vim**: Controlli familiari per gli utenti esperti del terminale.
- **Supporto Offline**: Memorizza gli articoli nella cache per la lettura senza connessione internet.
- **Temi Personalizzabili**: Supporto per schemi di colori del terminale sia chiari che scuri.
+- **Privacy al primo posto**: Nessun tracciamento, nessun account e nessuna sincronizzazione cloud. Tutti i dati rimangono sul tuo dispositivo locale.
+- **Prima l'offline**: Articoli, feed e impostazioni sono memorizzati localmente utilizzando IndexedDB per un accesso offline senza interruzioni.
+- **Estrazione del testo completo**: Include una "Modalità Lettura" dedicata per estrarre contenuti puliti da qualsiasi URL con un singolo clic.
+- **Ricerca globale**: Potenti funzionalità di ricerca full-text in tutta la cronologia di lettura.
+- **Feed intelligente**: Classifica personalizzata elaborata localmente in base alle tue abitudini di lettura.
+- **Scorciatoie in stile Vim**: Navigazione efficiente utilizzando i familiari controlli da tastiera.
+- **Lettore personalizzabile**: Supporto per vari font (Serif/Sans), dimensioni regolabili e altezze di riga.

-## Installazione
+## Privacy e sicurezza

-Puoi scaricare l'ultimo binario per il tuo sistema operativo dalla pagina principale.
+Web News è costruito su una filosofia "zero-knowledge" per garantire che i dati degli utenti rimangano privati:
+- **Sovranità dei dati**: La tua lista di lettura e la tua cronologia non lasciano mai il tuo dispositivo.
+- **Accesso anonimo**: Utilizza numeri di conto a 16 cifre per l'accesso al server invece di identificatori personali.
+- **Backend blindato**: Include blocco dei bot integrato, limitazione della frequenza e generazione di token sicuri.
+
+## Iniziare
+
+### Prerequisiti
+
+- Go 1.21 o superiore
+- Node.js 18 o superiore
+- pnpm 9 o superiore
+
+### Compilazione ed esecuzione
+
+Per compilare ed eseguire il server web:

 ```bash
-# Esempio di utilizzo
-webnews --sync
+make build
+./bin/web-news
+```
+
+Per le build delle applicazioni desktop (richiede Wails CLI):
+
+```bash
+make desktop-build
 ```

 ## Configurazione

-La configurazione è memorizzata in `~/.config/webnews/config.yaml` per impostazione predefinita.
+L'applicazione può essere configurata utilizzando i seguenti flag del server:

-```yaml
-sources:
-  - https://hnrss.org/frontpage
-  - https://lobste.rs/rss
-```
+- `--auth-mode`: Impostare su `none`, `token` o `multi`.
+- `--port`: La porta su cui ascoltare (il valore predefinito è `8080`).
+- `--allow-registration`: Abilita o disabilita la generazione di nuovi numeri di conto.

---
+## Scorciatoie da tastiera

-_Questo è un file di documentazione di test renderizzato da Markdown._
+- `j` / `k`: Naviga all'articolo successivo o precedente.
+- `r`: Segna l'articolo corrente come letto.
+- `s`: Attiva/disattiva lo stato salvato di un articolo.
+- `x`: Attiva/disattiva la modalità di selezione multipla.
+- `o`: Apri l'URL dell'articolo originale.
--- a/frontend/src/lib/docs/software/webnews.md
+++ b/frontend/src/lib/docs/software/webnews.md
@@ -1,33 +1,61 @@
-# WebNews
+# Web News

-WebNews is a high-performance terminal-based news reader designed for simplicity and speed.
+Web News is a privacy-focused, offline-first RSS reader and full-text extractor. It combines a Svelte-based reactive frontend with a high-performance Go-based backend, available as a standalone web server or a native desktop application.
+
+[Source Code](https://git.quad4.io/Quad4-Software/webnews)

 ## Features

- **Blazing Fast**: Written in Go for optimal performance.
- **Vim-like Keybindings**: Familiar controls for terminal power users.
- **Offline Support**: Cache articles for reading without an internet connection.
- **Customizable Themes**: Support for both light and dark terminal schemes.
+- **Privacy-First**: No tracking, no accounts, and no cloud synchronization. All data remains on your local device.
+- **Offline-First**: Articles, feeds, and settings are stored locally using IndexedDB for seamless offline access.
+- **Full-Text Extraction**: Includes a dedicated "Read Mode" to extract clean content from any URL with a single click.
+- **Global Search**: Powerful full-text search capabilities across your entire reading history.
+- **Smart Feed**: Locally-processed personalized ranking based on your reading habits.
+- **Vim-like Shortcuts**: Efficient navigation using familiar keyboard controls.
+- **Customizable Reader**: Support for various fonts (Serif/Sans), adjustable sizes, and line heights.

-## Installation
+## Privacy and Security

-You can download the latest binary for your operating system from the main page.
+Web News is built on a "zero-knowledge" philosophy to ensure user data remains private:
+- **Data Sovereignty**: Your reading list and history never leave your device.
+- **Anonymous Access**: Uses 16-digit account numbers for server access instead of personal identifiers.
+- **Hardened Backend**: Features built-in bot blocking, rate limiting, and secure token generation.
+
+## Getting Started
+
+### Prerequisites
+
+- Go 1.21 or higher
+- Node.js 18 or higher
+- pnpm 9 or higher
+
+### Build and Run
+
+To build and run the web server:

 ```bash
-# Example usage
-webnews --sync
+make build
+./bin/web-news
+```
+
+For desktop application builds (requires Wails CLI):
+
+```bash
+make desktop-build
 ```

 ## Configuration

-Configuration is stored in `~/.config/webnews/config.yaml` by default.
+The application can be configured using the following server flags:

-```yaml
-sources:
-  - https://hnrss.org/frontpage
-  - https://lobste.rs/rss
-```
+- `--auth-mode`: Set to `none`, `token`, or `multi`.
+- `--port`: The port to listen on (default is `8080`).
+- `--allow-registration`: Enable or disable the generation of new account numbers.

---
+## Keyboard Shortcuts

-_This is a test documentation file rendered from Markdown._
+- `j` / `k`: Navigate to the next or previous article.
+- `r`: Mark the current article as read.
+- `s`: Toggle the saved status of an article.
+- `x`: Toggle multi-select mode.
+- `o`: Open the original article URL.
--- a/frontend/src/lib/docs/software/webnews.ru.md
+++ b/frontend/src/lib/docs/software/webnews.ru.md
@@ -1,33 +1,61 @@
-# WebNews
+# Web News

-WebNews — это высокопроизводительный терминальный агрегатор новостей, разработанный для простоты и скорости.
+Web News — это ориентированный на конфиденциальность RSS-ридер с поддержкой автономного режима и извлечением полного текста. Он сочетает в себе реактивный интерфейс на Svelte с высокопроизводительным серверным движком на Go, доступным как в виде отдельного веб-сервера, так и в виде нативного приложения для рабочего стола.
+
+[Исходный код](https://git.quad4.io/Quad4-Software/webnews)

 ## Особенности

- **Невероятно быстрый**: Написан на Go для оптимальной производительности.
- **Vim-подобные горячие клавиши**: Привычное управление для продвинутых пользователей терминала.
- **Автономный режим**: Кэширование статей для чтения без подключения к интернету.
- **Настраиваемые темы**: Поддержка светлых и темных схем терминала.
+- **Конфиденциальность прежде всего**: Никакого отслеживания, учетных записей или облачной синхронизации. Все данные остаются на вашем локальном устройстве.
+- **Сначала оффлайн**: Статьи, ленты и настройки хранятся локально с использованием IndexedDB для бесперебойного доступа в автономном режиме.
+- **Извлечение полного текста**: Включает специальный «Режим чтения» для извлечения чистого содержимого из любого URL-адреса одним щелчком мыши.
+- **Глобальный поиск**: Мощные возможности полнотекстового поиска по всей истории чтения.
+- **Умная лента**: Персонализированное ранжирование на основе ваших привычек чтения, обрабатываемое локально.
+- **Горячие клавиши в стиле Vim**: Эффективная навигация с использованием привычных элементов управления клавиатурой.
+- **Настраиваемый ридер**: Поддержка различных шрифтов (с засечками и без), настраиваемых размеров и высоты строк.

-## Установка
+## Конфиденциальность и безопасность

-Вы можете скачать последнюю версию бинарного файла для вашей операционной системы на главной странице.
+Web News построен на философии «нулевого знания», чтобы гарантировать приватность пользовательских данных:
+- **Суверенитет данных**: Ваш список чтения и история никогда не покидают ваше устройство.
+- **Анонимный доступ**: Использует 16-значные номера счетов для доступа к серверу вместо личных идентификаторов.
+- **Защищенный бэкенд**: Встроенная блокировка ботов, ограничение скорости и безопасная генерация токенов.
+
+## Начало работы
+
+### Предварительные условия
+
+- Go 1.21 или выше
+- Node.js 18 или выше
+- pnpm 9 или выше
+
+### Сборка и запуск
+
+Чтобы собрать и запустить веб-сервер:

 ```bash
-# Пример использования
-webnews --sync
+make build
+./bin/web-news
+```
+
+Для сборки настольного приложения (требуется Wails CLI):
+
+```bash
+make desktop-build
 ```

 ## Конфигурация

-Конфигурация по умолчанию хранится в `~/.config/webnews/config.yaml`.
+Приложение можно настроить с помощью следующих серверных флагов:

-```yaml
-sources:
-  - https://hnrss.org/frontpage
-  - https://lobste.rs/rss
-```
+- `--auth-mode`: Установите значение `none`, `token` или `multi`.
+- `--port`: Порт для прослушивания (по умолчанию `8080`).
+- `--allow-registration`: Включить или отключить генерацию новых номеров счетов.

---
+## Горячие клавиши

-_Это тестовый файл документации, отрисованный из Markdown._
+- `j` / `k`: Перейти к следующей или предыдущей статье.
+- `r`: Отметить текущую статью как прочитанную.
+- `s`: Переключить статус сохранения статьи.
+- `x`: Переключить режим множественного выбора.
+- `o`: Открыть исходный URL-адрес статьи.