Adds Discord Bot to Hugo Server Documentation (#1336)

* Updated Copy * added discord bot to hugo menu * fixed indentation * Added bot branch to main * added discord to tree * added discord bot to hugo documentation * Spelling * Spelling
2026-10-27 12:40:35 +00:00 · 2022-02-08 16:27:44 -08:00
parent f8fc7d00ff
commit 68d9cc1efb
4 changed files with 139 additions and 17 deletions
--- a/website/content/_index.md
+++ b/website/content/_index.md
@@ -33,55 +33,55 @@ resources:

 <!-- markdownlint-restore -->

-**A modern investment research tool for Everyone.**
+### **High Quality FOSS Investment Research Tools For Everyone**

 <!--{{< img name="GST" lazy=false >}}-->

-Gamestonk Terminal provides a modern Python-based integrated environment for investment research, that allows the average joe retail trader to leverage state-of-the-art Data Science and Machine Learning technologies.
+Gamestonk Terminal provides a modern, and fully customizable, Python-based integrated environment for investment research. Leveraging state-of-the-art data science and machine learning, the individual trader can now harness technologies used by institutions and professionals around the world to make better financial decisions.

-As a modern Python-based environment, GamestonkTerminal opens access to numerous Python data libraries in Data Science (Pandas, Numpy, Scipy, Jupyter), Machine Learning (Pytorch, Tensorflow, Sklearn, Flair), and Data Acquisition (Beautiful Soup, and numerous third-party APIs).
+As a modern Python-based environment, GamestonkTerminal opens access to numerous Python data libraries in data science (Pandas, Numpy, Scipy, Jupyter), machine learning (Pytorch, Tensorflow, Sklearn, Flair), and data acquisition (Beautiful Soup, and numerous third-party APIs).

 <!--{{< button size="large" relref="stocks/" >}}Getting Started{{< /button >}}-->

-## Feature overview
+### Feature overview

 {{< columns >}}

-### Clean and simple design
+### Ad-Free Experience

-Stay focused on exploring the content and don't get overwhelmed by a complex design.
+Don't let your research be influenced algorithmic advertisements. Gamestonk Terminal provides a fast workflow that is ad-free and uncompromising.

 <--->

-### Light and mobile-friendly
+### Fully Customizable

-The theme is powered by less than 1 MB and looks impressive on mobile devices as well as on a regular Desktop.
+The MIT Open Source license allows any user to endlessly customize the suite for their specific needs. 

 <--->

-### Easy customization
+### Jupyter Labs Enabled

-The look and feel can be easily customized by CSS custom properties (variables), features can be adjusted by Hugo parameters.
+Work in developer mode with Jupyter Labs, or share reports and customized tools with .ipynb Notebook files. Run multiple dashboards or terminals in parallel. 

 {{< /columns >}}

 {{< columns >}}

-### Zero initial configuration
+### Discord Bot

-Getting started in minutes. The theme is shipped with a default configuration and works out of the box.
+A powerful and interactive Discord Bot, complete with a Plotly charting library, for anyone to install and use in public or private servers; without limits.

 <--->

-### Handy shortcodes
+### Simple Scripts For Automated Processes

-We included some (hopefully) useful custom shortcodes so you don't have to and can focus on writing amazing docs.
+Generate automated reports, charts, and more using the unique simple script batch command for repetitive or scheduled tasks.

 <--->

-### Dark mode
+### Import Your Own Data Sets To Plot, Analyze, Or Predict

-Powerful dark mode that detects your system preferences or can be controlled by a toggle switch.
+Statisticians and data scientists can harness the power of Tensorflow and quantitative analysis by importing CSV data sets in the custom menu.

 {{< /columns >}}

--- a/website/content/bot/_index.md
+++ b/website/content/bot/_index.md
@@ -0,0 +1,7 @@
+The Gamestonk Terminal Bot is a mobile-friendly social media chat bot. This version is meant to be deployed on Discord, but there may be other compatible venues such as Telegram. Find the installation instructions here: https://github.com/GamestonkTerminal/GamestonkTerminal/tree/main/discordbot#readme
+
+---
+geekdocCollapseSection: true
+---
+
+{{< toc-tree >}}
--- a/website/content/bot/discord/_index.md
+++ b/website/content/bot/discord/_index.md
@@ -0,0 +1,111 @@
+The Discord Bot can be added to a server by users with admin privileges through the link below: 
+
+https://discord.com/oauth2/authorize?client_id=927232119346962513&permissions=510500797553&scope=bot%20applications.commands
+
+<img width="1400" alt="Discord Bot on GST Discord Server" src="https://user-images.githubusercontent.com/85772166/153071762-9da3845d-da06-47af-a147-bea5488524a3.png">
+
+Users can interact with the bot through both direct messages and the server. Alternatively, the bot can be run locally on a private server using the installation instructions found here: https://github.com/GamestonkTerminal/GamestonkTerminal/tree/main/discordbot#readme
+
+The bot is called by using the slash key - / - in the server or in a direct message to the bot. To explore the commands, click on the bot's avatar.
+
+<img width="1400" alt="Discord Bot Slash Command Example" src="https://user-images.githubusercontent.com/85772166/153072692-c3d458ef-1f5a-48c8-9173-6d35e0af5ad1.png">
+
+/cmds will show a text list of commands along with the different options available for each.
+
+<img width="1400" alt="Discord Bot Command List" src="https://user-images.githubusercontent.com/85772166/153074728-95b1dfff-10d8-43f7-a6a7-59f904975ada.png">
+
+```
+[ta-summary](ticker)
+[ta-view](ticker)
+[ta-recom](ticker)
+[ta-obv](ticker) <START> <END>
+[ta-fib](ticker) <START> <END>
+[ta-ad](ticker) <OPEN> <START> <END>
+[ta-cg](ticker) <LENGTH> <START> <END>
+[ta-fisher](ticker) <LENGTH> <START> <END>
+[ta-cci](ticker) <LENGTH> <SCALAR> <START> <END>
+[ta-ema](ticker) <WINDOW> <OFFSET> <START> <END>
+[ta-sma](ticker) <WINDOW> <OFFSET> <START> <END>
+[ta-wma](ticker) <WINDOW> <OFFSET> <START> <END>
+[ta-hma](ticker) <WINDOW> <OFFSET> <START> <END>
+[ta-zlma](ticker) <WINDOW> <OFFSET> <START> <END>
+[ta-aroon](ticker) <LENGTH> <SCALAR> <START> <END>
+[ta-adosc](ticker) <OPEN> <FAST> <SLOW> <START> <END>
+[ta-macd](ticker) <FAST> <SLOW> <SIGNAL> <START> <END>
+[ta-kc](ticker) <LENGTH> <SCALAR> <MA_MODE> <START> <END>
+[ta-adx](ticker) <LENGTH> <SCALAR> <DRIFT> <START> <END>
+[ta-rsi](ticker) <LENGTH> <SCALAR> <DRIFT> <START> <END>
+[ta-stoch](ticker) <FAST_K> <SLOW_D> <SLOW_K> <START> <END>
+[ta-bbands](ticker) <LENGTH> <SCALAR> <MA_MODE> <START> <END>
+[ta-donchian](ticker) <LWR_LENGTH> <UPR_LENGTH> <START> <END>
+
+[opt-unu]()
+[opt-iv](ticker)
+[opt-vsurf](ticker) <z>
+[opt-hist](ticker) <strike> <expiration> <opt-typ>
+[opt-oi](ticker) <expiration> <min-sp> <max-sp>
+[opt-vol](ticker) <expiration> <min-sp> <max-sp>
+[opt-overview](ticker) <expiration> <min-sp> <max-sp>
+[opt-chain](ticker) <expiration> <opt-typ> <min-sp> <max-sp>
+
+[dps.hsi]() <NUM>
+[dps.shorted](NUM)
+[dps.psi](ticker)
+[dps.spos](ticker)
+[dps.dpotc](ticker)
+[dps.pos]() <NUM> <SORT>
+[dps.sidtc]() <NUM> <SORT>
+[dps.ftd](ticker) <DATE_START> <DATE_END>
+
+[dd-est](ticker)
+[dd-sec](ticker)
+[dd-analyst](ticker)
+[dd-supplier](ticker)
+[dd-customer](ticker)
+[dd-arktrades](ticker)
+[dd-pt](ticker) <RAW> <DATE_START>
+
+[scr.presets_default]()
+[scr.presets_custom]()
+[scr.historical](SIGNAL) <START>
+[scr.overview](PRESET) <SORT> <LIMIT> <ASCEND>
+[scr.technical](PRESET) <SORT> <LIMIT> <ASCEND>
+[scr.valuation](PRESET) <SORT> <LIMIT> <ASCEND>
+[scr.financial](PRESET) <SORT> <LIMIT> <ASCEND>
+[scr.ownership](PRESET) <SORT> <LIMIT> <ASCEND>
+[scr.performance](PRESET) <SORT> <LIMIT> <ASCEND>
+
+[gov-histcont](ticker)
+[gov-lobbying](ticker) <NUM>
+[gov-toplobbying]() <NUM> <RAW>
+[gov-lastcontracts]() <DAYS> <NUM>
+[gov-contracts](ticker) <DAYS> <RAW>
+[gov-qtrcontracts]() <ANALYSIS> <NUM>
+[gov-lasttrades]() <GOV_TYPE> <DAYS> <REP>
+[gov-gtrades](ticker) <GOV_TYPE> <MONTHS> <RAW>
+[gov-topbuys]() <GOV_TYPE> <MONTHS> <NUM> <RAW>
+[gov-topsells]() <GOV_TYPE> <MONTHS> <NUM> <RAW>
+<DAYS> = Past Transaction Days
+<MONTHS> = Past Transaction Months
+
+[econ-softs]()
+[econ-meats]()
+[econ-energy]()
+[econ-metals]()
+[econ-grains]()
+[econ-futures]()
+[econ-usbonds]()
+[econ-glbonds]()
+[econ-indices]()
+[econ-overview]()
+[econ-feargreed]()
+[econ-currencies]()
+[econ-valuation]() <GROUP>
+[econ-performance]() <GROUP>
+
+[disc-fidelity]()
+[ins-last](ticker) <num>
+[q](ticker)
+
+```
+<img width="1400" alt="Discord Bot Sample Output - /cc SPY" src="https://user-images.githubusercontent.com/85772166/153075094-42a608f4-04a9-4a83-9e41-3eb31f34ba30.png">
--- a/website/data/menu/main.yml
+++ b/website/data/menu/main.yml
@@ -612,7 +612,6 @@ main:
            ref: "/common/prediction_techniques/conv1d"
          - name: mc
            ref: "/common/prediction_techniques/mc"
-
  - name: cryptocurrency
    ref: "/cryptocurrency"
    sub:
@@ -1254,3 +1253,8 @@ main:
            ref: "jupyter/dashboards/shortdata"
      - name: "reports"
        ref: "/jupyter/reports"
+  - name: bot
+    ref: "/bot"
+    sub:
+      - name: "discord"
+        ref: "/bot/discord"