From e628650dd1002439e52d6d8303f2e48540271dec Mon Sep 17 00:00:00 2001
From: Alicia Sykes
Date: Mon, 27 Dec 2021 22:22:49 +0000
Subject: [PATCH] :memo: Adds widget docs to readme
---
README.md | 17 +++++++++++++++++
docs/widgets.md | 11 +++++++++++
2 files changed, 28 insertions(+)
diff --git a/README.md b/README.md
index b0be193f..570b0557 100644
--- a/README.md
+++ b/README.md
@@ -40,6 +40,7 @@
- [🎨 Theming](#theming-)
- [🧸 Icons](#icons-)
- [🚦 Status Indicators](#status-indicators-)
+ - [📊 Widgets](#widgets-)
- [💂 Authentication](#authentication-)
- [🖱️ Opening Methods](#opening-methods-%EF%B8%8F)
- [👓 Alternate Views](#alternate-views-)
@@ -235,6 +236,22 @@ Status indicators can be globally enabled by setting `appConfig.statusCheck: tru
+**[⬆️ Back to Top](#dashy)**
+
+---
+
+## Widgets 📊
+
+> For full widget documentation, see: [**Widgets**](./docs/widgets.md)
+
+You can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.
+
+
+
+
+
+
+
**[⬆️ Back to Top](#dashy)**
---
diff --git a/docs/widgets.md b/docs/widgets.md
index 677b741a..053969ab 100644
--- a/docs/widgets.md
+++ b/docs/widgets.md
@@ -43,6 +43,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [Widget Usage Guide](#widget-usage-guide)
- [Continuous Updates](#continuous-updates)
- [Custom CSS Styling](#widget-styling)
+ - [Language Translations](#language-translations)
- [Widget UI Options](#widget-ui-options)
- [Building a Widget](#build-your-own-widget)
@@ -1158,6 +1159,16 @@ For more info on how to apply custom variables, see the [Theming Docs](/docs/the
---
+### Language Translations
+
+Since most of the content displayed within widgets is fetched from an external API, unless that API supports multiple languages, translating dynamic content is not possible.
+
+However, any hard-coded content is translatable, and all dates and times will display in your local format.
+
+For more info about multi-language support, see the [Internationalization Docs](/docs/multi-language-support.md).
+
+---
+
### Widget UI Options
Widgets can be opened in full-page view, by clicking the Arrow icon (top-right). The URL in your address bar will also update, and visiting that web address will take you straight to the selected widget.