From f6ff9b041978cc6df4317fd7c759f14aff321df1 Mon Sep 17 00:00:00 2001 From: misagh Date: Fri, 28 Dec 2018 16:16:04 +0100 Subject: [PATCH] changed to introduction --- docs/index.md | 2 +- docs/pre-requisite.md | 20 +++++++++----------- mkdocs.yml | 2 +- 3 files changed, 11 insertions(+), 13 deletions(-) diff --git a/docs/index.md b/docs/index.md index 8fa24e996..afbc0a73a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# freqtrade documentation +# Introduction Welcome to freqtrade documentation. Please feel free to contribute to this documentation if you see it became outdated by sending us a diff --git a/docs/pre-requisite.md b/docs/pre-requisite.md index 79232a89d..2ff3f08b5 100644 --- a/docs/pre-requisite.md +++ b/docs/pre-requisite.md @@ -3,7 +3,6 @@ Before running your bot in production you will need to setup few external API. In production mode, the bot required valid Bittrex API credentials and a Telegram bot (optional but recommended). -## Table of Contents - [Setup your Bittrex account](#setup-your-bittrex-account) - [Backtesting commands](#setup-your-telegram-bot) @@ -16,20 +15,20 @@ Below we explain how to create your Telegram Bot, and how to get your Telegram user id. ### 1. Create your Telegram bot -**1.1. Start a chat with https://telegram.me/BotFather** -**1.2. Send the message** `/newbot` +**1.1. Start a chat with https://telegram.me/BotFather** +**1.2. Send the message** `/newbot` *BotFather response:* ``` Alright, a new bot. How are we going to call it? Please choose a name for your bot. ``` -**1.3. Choose the public name of your bot (e.g "`Freqtrade bot`")** +**1.3. Choose the public name of your bot (e.g "`Freqtrade bot`")** *BotFather response:* ``` Good. Now let's choose a username for your bot. It must end in `bot`. Like this, for example: TetrisBot or tetris_bot. ``` -**1.4. Choose the name id of your bot (e.g "`My_own_freqtrade_bot`")** -**1.5. Father bot will return you the token (API key)** -Copy it and keep it you will use it for the config parameter `token`. +**1.4. Choose the name id of your bot (e.g "`My_own_freqtrade_bot`")** +**1.5. Father bot will return you the token (API key)** +Copy it and keep it you will use it for the config parameter `token`. *BotFather response:* ``` Done! Congratulations on your new bot. You will find it at t.me/My_own_freqtrade_bot. You can now add a description, about section and profile picture for your bot, see /help for a list of commands. By the way, when you've finished creating your cool bot, ping our Bot Support if you want a better username for it. Just make sure the bot is fully operational before you do this. @@ -39,10 +38,9 @@ Use this token to access the HTTP API: For a description of the Bot API, see this page: https://core.telegram.org/bots/api ``` -**1.6. Don't forget to start the conversation with your bot, by clicking /START button** +**1.6. Don't forget to start the conversation with your bot, by clicking /START button** ### 2. Get your user id -**2.1. Talk to https://telegram.me/userinfobot** -**2.2. Get your "Id", you will use it for the config parameter +**2.1. Talk to https://telegram.me/userinfobot** +**2.2. Get your "Id", you will use it for the config parameter `chat_id`.** - diff --git a/mkdocs.yml b/mkdocs.yml index db01194cc..7ad68178b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ theme: logo: 'images/logo.png' palette: primary: 'blue grey' - accent: 'deep orange' + accent: 'tear' markdown_extensions: - admonition - codehilite: