Merge pull request #1737 from freqtrade/doc/simplify
Improve documentation formatting
This commit is contained in:
commit
1bfc667515
@ -1,13 +1,13 @@
|
|||||||
# Telegram usage
|
# Telegram usage
|
||||||
|
|
||||||
This page explains how to command your bot with Telegram.
|
|
||||||
|
|
||||||
## Prerequisite
|
## Prerequisite
|
||||||
|
|
||||||
To control your bot with Telegram, you need first to
|
To control your bot with Telegram, you need first to
|
||||||
[set up a Telegram bot](installation.md)
|
[set up a Telegram bot](installation.md)
|
||||||
and add your Telegram API keys into your config file.
|
and add your Telegram API keys into your config file.
|
||||||
|
|
||||||
## Telegram commands
|
## Telegram commands
|
||||||
|
|
||||||
Per default, the Telegram bot shows predefined commands. Some commands
|
Per default, the Telegram bot shows predefined commands. Some commands
|
||||||
are only available by sending them to the bot. The table below list the
|
are only available by sending them to the bot. The table below list the
|
||||||
official commands. You can ask at any moment for help with `/help`.
|
official commands. You can ask at any moment for help with `/help`.
|
||||||
|
@ -1,7 +1,5 @@
|
|||||||
# Webhook usage
|
# Webhook usage
|
||||||
|
|
||||||
This page explains how to configure your bot to talk to webhooks.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Enable webhooks by adding a webhook-section to your configuration file, and setting `webhook.enabled` to `true`.
|
Enable webhooks by adding a webhook-section to your configuration file, and setting `webhook.enabled` to `true`.
|
||||||
@ -39,32 +37,30 @@ Different payloads can be configured for different events. Not all fields are ne
|
|||||||
The fields in `webhook.webhookbuy` are filled when the bot executes a buy. Parameters are filled using string.format.
|
The fields in `webhook.webhookbuy` are filled when the bot executes a buy. Parameters are filled using string.format.
|
||||||
Possible parameters are:
|
Possible parameters are:
|
||||||
|
|
||||||
* exchange
|
* `exchange`
|
||||||
* pair
|
* `pair`
|
||||||
* limit
|
* `limit`
|
||||||
* stake_amount
|
* `stake_amount`
|
||||||
* stake_amount_fiat
|
* `stake_currency`
|
||||||
* stake_currency
|
* `fiat_currency`
|
||||||
* fiat_currency
|
|
||||||
|
|
||||||
### Webhooksell
|
### Webhooksell
|
||||||
|
|
||||||
The fields in `webhook.webhooksell` are filled when the bot sells a trade. Parameters are filled using string.format.
|
The fields in `webhook.webhooksell` are filled when the bot sells a trade. Parameters are filled using string.format.
|
||||||
Possible parameters are:
|
Possible parameters are:
|
||||||
|
|
||||||
* exchange
|
* `exchange`
|
||||||
* pair
|
* `pair`
|
||||||
* gain
|
* `gain`
|
||||||
* limit
|
* `limit`
|
||||||
* amount
|
* `amount`
|
||||||
* open_rate
|
* `open_rate`
|
||||||
* current_rate
|
* `current_rate`
|
||||||
* profit_amount
|
* `profit_amount`
|
||||||
* profit_percent
|
* `profit_percent`
|
||||||
* profit_fiat
|
* `stake_currency`
|
||||||
* stake_currency
|
* `fiat_currency`
|
||||||
* fiat_currency
|
* `sell_reason`
|
||||||
* sell_reason
|
|
||||||
|
|
||||||
### Webhookstatus
|
### Webhookstatus
|
||||||
|
|
||||||
|
@ -3,9 +3,10 @@ nav:
|
|||||||
- About: index.md
|
- About: index.md
|
||||||
- Installation: installation.md
|
- Installation: installation.md
|
||||||
- Configuration: configuration.md
|
- Configuration: configuration.md
|
||||||
- Start the bot: bot-usage.md
|
|
||||||
- Stoploss: stoploss.md
|
|
||||||
- Custom Strategy: bot-optimization.md
|
- Custom Strategy: bot-optimization.md
|
||||||
|
- Stoploss: stoploss.md
|
||||||
|
- Start the bot: bot-usage.md
|
||||||
|
- Control the bot:
|
||||||
- Telegram: telegram-usage.md
|
- Telegram: telegram-usage.md
|
||||||
- Web Hook: webhook-config.md
|
- Web Hook: webhook-config.md
|
||||||
- Backtesting: backtesting.md
|
- Backtesting: backtesting.md
|
||||||
|
Loading…
Reference in New Issue
Block a user