chore: update docs (#580)

+semver: minor
DaveSkender · Oct 11, 2021 · 9e819ee · 9e819ee
1 parent 716e60b
commit 9e819ee
Show file tree

Hide file tree

Showing 32 changed files with 10 additions and 9 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,6 +6,6 @@ updates:
     schedule:
       interval: "weekly"
   - package-ecosystem: "bundler"
-    directory: "/"
+    directory: "/docs"
     schedule:
       interval: "weekly"
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 It can be used in any market analysis software using standard OHLCV price quotes for equities, commodities, forex, cryptocurrencies, and others.  We had private trading algorithms, machine learning, and charting systems in mind when originally creating this community library.
 
-More information:
+Visit our project site for more information:
 
 - [Overview](https://daveskender.github.io/Stock.Indicators/)
 - [Indicators and overlays](https://daveskender.github.io/Stock.Indicators/indicators/)

diff --git a/docs/README.md b/docs/README.md
@@ -13,7 +13,7 @@ Explore more information:
 - [Indicators and overlays]({{site.baseurl}}/indicators/#content)
 - [Guide and Pro tips]({{site.baseurl}}/guide/#content)
 - [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
-- [Example code]({{site.baseurl}}/examples/#content)
+- [Example usage code]({{site.baseurl}}/examples/#content)
 - [Release notes]({{site.github.repository_url}}/releases)
 - [Discussions]({{site.github.repository_url}}/discussions)
 - [Contributing guidelines]({{site.baseurl}}/contributing/#content)

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -98,6 +98,7 @@ indicators:
   - href: /indicators/Sma/
   - href: /indicators/Smma/
   - href: /indicators/StarcBands/
+  - href: /indicators/Stc/
   - href: /indicators/StdDev/
   - href: /indicators/StdDevChannels/
   - href: /indicators/Stoch/

diff --git a/docs/_indicators/Renko.md b/docs/_indicators/Renko.md
@@ -1,5 +1,5 @@
 ---
-title: Renko Chart (Preview)
+title: Renko Chart
 permalink: /indicators/Renko/
 layout: default
 ---

diff --git a/docs/guide.md b/docs/guide.md
@@ -79,7 +79,7 @@ See [individual indicator pages]({{site.baseurl}}/indicators/) for specific usag
 
 More examples available:
 
-- [Example code]({{site.baseurl}}/examples/#content) in a simple working console application
+- [Example usage code]({{site.baseurl}}/examples/#content) in a simple working console application
 - [Demo site](https://stock-charts.azurewebsites.net) (a stock chart)
 
 ## Historical quotes
@@ -97,7 +97,7 @@ You must provide historical price quotes to the library in the standard OHLCV `I
 
 ### Where can I get historical quote data?
 
-There are many places to get stock market data.  Check with your brokerage or other commercial sites.  If you're looking for a free developer API, try [Polygon.io](https://polygon.io), [TwelveData](https://twelvedata.com), or [Alpha Vantage](https://www.alphavantage.co).
+There are many places to get stock market data.  Check with your brokerage or other commercial sites.  If you're looking for a free developer API, see our ongoing [discussion on market data]({{site.github.repository_url}}/discussions/579) for ideas.
 
 ### How much historical quote data do I need?
 

diff --git a/docs/indicators.md b/docs/indicators.md
@@ -44,6 +44,7 @@ redirect_from:
 
 ## Oscillators
 
+- [Awesome Oscillator](../indicators/Awesome/#content)
 - [ConnorsRSI](../indicators/ConnorsRsi/#content)
 - [Commodity Channel Index](../indicators/Cci/#content)
 - [Detrended Price Oscillator (DPO)](../indicators/Dpo/#content)
@@ -113,7 +114,6 @@ redirect_from:
 ## Price characteristics
 
 - [Average True Range (ATR)](../indicators/Atr/#content)
-- [Awesome Oscillator](../indicators/Awesome/#content)
 - [Balance of Power](../indicators/Bop/#content)
 - [Bull and Bear Power](../indicators/ElderRay/#content)
 - [Choppiness Index](../indicators/Chop/#content)

diff --git a/src/m-r/Renko/info.xml b/src/m-r/Renko/info.xml
@@ -4,7 +4,7 @@
 
   <type name="standard">
     <summary>
-      (preview) Renko Chart is a modified Japanese candlestick pattern that uses time-lapsed bricks.
+      Renko Chart is a modified Japanese candlestick pattern that uses time-lapsed bricks.
       <para>
         See
         <see href="https://daveskender.github.io/Stock.Indicators/indicators/Renko/#content">documentation</see>
@@ -22,7 +22,7 @@
 
   <type name="atr">
     <summary>
-      (preview) The ATR Renko Chart is a modified Japanese candlestick pattern based on Average True Range brick size.
+      The ATR Renko Chart is a modified Japanese candlestick pattern based on Average True Range brick size.
       <para>
         See
         <see href="https://daveskender.github.io/Stock.Indicators/indicators/Renko/#content">documentation</see>

diff --git a/tests/indicators/_common/Data.Aggregate.xlsx b/tests/indicators/_common/Data.Aggregate.xlsx
diff --git a/tests/indicators/a-d/Adl/Adl.Calc.xlsx b/tests/indicators/a-d/Adl/Adl.Calc.xlsx
diff --git a/tests/indicators/a-d/Aroon/Aroon.Calc.xlsx b/tests/indicators/a-d/Aroon/Aroon.Calc.xlsx
diff --git a/tests/indicators/a-d/Atr/Atr.Calc.xlsx b/tests/indicators/a-d/Atr/Atr.Calc.xlsx
diff --git a/tests/indicators/a-d/Awesome/Awesome.Calc.xlsx b/tests/indicators/a-d/Awesome/Awesome.Calc.xlsx
diff --git a/tests/indicators/a-d/BollingerBands/BollingerBands.Calc.xlsx b/tests/indicators/a-d/BollingerBands/BollingerBands.Calc.xlsx
diff --git a/tests/indicators/a-d/Cmf/Cmf.Calc.xlsx b/tests/indicators/a-d/Cmf/Cmf.Calc.xlsx
diff --git a/tests/indicators/a-d/ConnorsRsi/ConnorsRsi.Calc.xlsx b/tests/indicators/a-d/ConnorsRsi/ConnorsRsi.Calc.xlsx
diff --git a/tests/indicators/a-d/Donchian/Donchian.Calc.xlsx b/tests/indicators/a-d/Donchian/Donchian.Calc.xlsx
diff --git a/tests/indicators/e-k/Epma/Epma.Calc.xlsx b/tests/indicators/e-k/Epma/Epma.Calc.xlsx
diff --git a/tests/indicators/e-k/Kama/Kama.Calc.xlsx b/tests/indicators/e-k/Kama/Kama.Calc.xlsx
diff --git a/tests/indicators/m-r/Macd/Macd.Calc.xlsx b/tests/indicators/m-r/Macd/Macd.Calc.xlsx
diff --git a/tests/indicators/m-r/Marubozu/Marubozu.Calc.xlsx b/tests/indicators/m-r/Marubozu/Marubozu.Calc.xlsx
diff --git a/tests/indicators/m-r/Mfi/Mfi.Calc.xlsx b/tests/indicators/m-r/Mfi/Mfi.Calc.xlsx
diff --git a/tests/indicators/m-r/Obv/Obv.Calc.xlsx b/tests/indicators/m-r/Obv/Obv.Calc.xlsx
diff --git a/tests/indicators/m-r/Pmo/Pmo.Calc.xlsx b/tests/indicators/m-r/Pmo/Pmo.Calc.xlsx
diff --git a/tests/indicators/m-r/Prs/Prs.Calc.xlsx b/tests/indicators/m-r/Prs/Prs.Calc.xlsx
diff --git a/tests/indicators/s-z/StdDev/StdDev.Calc.xlsx b/tests/indicators/s-z/StdDev/StdDev.Calc.xlsx
diff --git a/tests/indicators/s-z/StochRsi/StochRsi.Calc.xlsx b/tests/indicators/s-z/StochRsi/StochRsi.Calc.xlsx
diff --git a/tests/indicators/s-z/Trix/Trix.Calc.xlsx b/tests/indicators/s-z/Trix/Trix.Calc.xlsx
diff --git a/tests/indicators/s-z/Ultimate/Ultimate.Calc.xlsx b/tests/indicators/s-z/Ultimate/Ultimate.Calc.xlsx
diff --git a/tests/indicators/s-z/VolSma/VolSma.Calc.xlsx b/tests/indicators/s-z/VolSma/VolSma.Calc.xlsx
diff --git a/tests/indicators/s-z/Wma/Wma.Calc.xlsx b/tests/indicators/s-z/Wma/Wma.Calc.xlsx
diff --git a/tests/indicators/s-z/ZigZag/ZigZag.Calc.xlsx b/tests/indicators/s-z/ZigZag/ZigZag.Calc.xlsx