Reorder and revamp the documentation #279
Conversation
|
Hyperopt using is described in our wiki. https://github.com/gcarq/freqtrade/wiki/Testing-new-strategies-with-Hyperopt |
|
I have to integrate it into this PR. One goal of this PR is to allow users to improve the documentation and also be able to track modifications. |
README.md
Outdated
| This software is for educational purposes only. Do not risk money which | ||
| you are afraid to lose. Always start by running a trading bot in Dry-run and do not engage money | ||
| before you understand how it works and what profit/loss you should | ||
| expect. |
There was a problem hiding this comment.
I wonder if we should use this opportunity to add a final note along the lines of USE THE SOFTWARE AT YOUR OWN RISK. THE AUTHORS AND ALL AFFILIATES ASSUME NO RESPONSIBILITY FOR YOUR TRADING RESULTS.
There was a problem hiding this comment.
I really like your additions here though.
There was a problem hiding this comment.
I like it. Added to the documentation.
| @@ -0,0 +1,157 @@ | |||
| # Bot Optimization | |||
There was a problem hiding this comment.
I think these should be Github wiki pages that we link to from README.md.
There was a problem hiding this comment.
The issue with the wiki is that no-one can edit it if you are not an admin. And even for us we cannot review and roll it back.
I would like to give the chance from non-tech to contribute to the doc.
|
Good stuff @glonlas 👍 |
|
But damn, all in all that was one awesome set of new documentation, good work! |
README.md
Outdated
| 'should' be stable on this branch, and is generally well tested. | ||
|
|
||
| ## Features | ||
| - [x] **Based on Python**: For botting on any operating system - |
There was a problem hiding this comment.
IIRC we require python3.6+ which should be mentioned somewhere
There was a problem hiding this comment.
I have added a whole section about the software requirements in the README.md
docs/bot-optimization.md
Outdated
|
|
||
| **With live data (do not alter your testdata files)** | ||
| ```bash | ||
| python3 ./freqtrade/main.py -c config.json backtesting --realistic-simulation --live |
There was a problem hiding this comment.
do we need to pass the -c here, shouldn't we use the config by default in backtestging/hyperopt?
docs/installation.md
Outdated
| cp config.json.example config.json | ||
| ``` | ||
| To edit the config please refer to the [Bot Configuration](https://github.com/gcarq/freqtrade/blob/develop/docs/configuration.md) page | ||
| 5. Create your DB file |
There was a problem hiding this comment.
aren't these created automatically?
docs/installation.md
Outdated
| ``` | ||
|
|
||
| **2.3.2. Install Python 3.6** | ||
| - [Python 3.6 MacOS offical page](https://www.python.org/downloads/mac-osx/) |
There was a problem hiding this comment.
IIRC on osx you can just brew install python3 to get the latest released version of python
There was a problem hiding this comment.
Yep, that is the preferable method.
docs/installation.md
Outdated
| source .env/bin/activate | ||
| pip3.6 install -r requirements.txt | ||
| pip3.6 install -e . | ||
| pip3.6 install hyperopt |
There was a problem hiding this comment.
Not needed, as hyperopt is in requirements.txt
|
Thank you very much for your review and comments. I am updating the PR, then we can merge it. |
glonlas
force-pushed
the
revamp_documentations
branch
from
09d81d5
to
cb7c36a
Compare
This PR improve the documentation by trying to explain in details all steps to set up the bot.
Broken element in this branch
You will see on README.md the image link and link to documentation pages are broken. This is normal. If you look closely the URL links to
/develop/branch.Missings parts