Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Resolve "Add a documentation" #43

Merged
merged 10 commits into from
Jan 13, 2025
Merged

Resolve "Add a documentation" #43

merged 10 commits into from
Jan 13, 2025

Conversation

btschwertfeger
Copy link
Owner

@btschwertfeger btschwertfeger commented Jan 10, 2025 •
edited
Loading

Summary

This MR provides the documentation for the kraken-infinity-grid algorithm

Must include:

  • Introduction
    • Kraken API (use different API keys for different instances)
    • Troubleshooting
  • Strategies (don't do switches, cDCA)
    • Technical background
    • GridHODL, GridSell, SWING, cDCA
    • Embed images ... reuse resources from private repository
    • Choosing the right strategy
    • Choosing the right interval and amount per grid
  • Getting Started
    • Pure Python
    • Docker / containerized
  • Configuration
    • Database configuration
    • Telegram notifications
    • Custom fee (it is using limit orders)
    • Command-line interface and environment variables
  • Need-to-knows
    • Explain unfilled surplus
    • python-kraken-sdk is reconnecting
    • Logging
  • Backtesting

Others:

  • Upload to readthedocs via CI

Closes #7

@btschwertfeger btschwertfeger added the documentation Improvements or additions to documentation label Jan 10, 2025
@btschwertfeger btschwertfeger added this to the Beta milestone Jan 10, 2025
@btschwertfeger btschwertfeger self-assigned this Jan 10, 2025
@btschwertfeger btschwertfeger changed the title [skip ci] Resolve "Add a documentation" Resolve "Add a documentation" Jan 12, 2025
@btschwertfeger btschwertfeger enabled auto-merge (squash) January 13, 2025 06:09
@btschwertfeger btschwertfeger merged commit c0ec3e5 into master Jan 13, 2025
22 checks passed
@btschwertfeger btschwertfeger deleted the 7-add-a-documentation branch January 13, 2025 06:12
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@LeonhardSchwertfeger LeonhardSchwertfeger Awaiting requested review from LeonhardSchwertfeger

Assignees

@btschwertfeger btschwertfeger

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
Beta
Development

Successfully merging this pull request may close these issues.

Add a documentation
1 participant
@btschwertfeger