From 3b04ebd91d64d1b76b26742aa4f93d3c1d2ad433 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 1 Jul 2024 17:06:40 -0700 Subject: [PATCH] minor docs --- docs/widgets/info/stocks.md | 6 ++++-- docs/widgets/services/stocks.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/widgets/info/stocks.md b/docs/widgets/info/stocks.md index c67c222c2..548bedb43 100644 --- a/docs/widgets/info/stocks.md +++ b/docs/widgets/info/stocks.md @@ -3,6 +3,8 @@ title: Stocks description: Stocks Information Widget Configuration --- +_(Find the Stocks service widget [here](../services/stocks.md))_ + The Stocks Information Widget allows you to include basic stock market data in your Homepage header. The widget includes the current price of a stock, and the change in price for the day. @@ -28,8 +30,8 @@ The information widget allows for up to 8 items in the watchlist. ```yaml - stocks: provider: finnhub - color: true # Optional | default = true - cache: 1 # Optional | Stocks widget default is to cache results for 1 minute + color: true # optional, defaults to true + cache: 1 # optional, default caches results for 1 minute watchlist: - GME - AMC diff --git a/docs/widgets/services/stocks.md b/docs/widgets/services/stocks.md index 214d30424..5d64c9aca 100644 --- a/docs/widgets/services/stocks.md +++ b/docs/widgets/services/stocks.md @@ -3,6 +3,8 @@ title: Stocks description: Stocks Service Widget Configuration --- +_(Find the Stocks information widget [here](../info/stocks.md))_ + The widget includes: - US stock market status @@ -17,7 +19,7 @@ signing up. Allowed fields: no configurable fields for this widget. -You must set `finnhub` as a provider in your `settings.yaml` like below: +You must set `finnhub` as a provider in your `settings.yaml`: ```yaml providers: @@ -33,7 +35,7 @@ limited if using the information and service widgets together. widget: type: stocks provider: finnhub - showUSMarketStatus: true # Optional | default = true + showUSMarketStatus: true # optional, defaults to true watchlist: - GME - AMC