diff --git a/doc/api/content/algo/getting-started/install.md b/doc/api/content/algo/getting-started/install.md index c1b8f34f2..50d22277e 100644 --- a/doc/api/content/algo/getting-started/install.md +++ b/doc/api/content/algo/getting-started/install.md @@ -3,8 +3,21 @@ title = "Install Prerequisites" weight = 1 +++ +These instructions assume you are using Microsoft Windows but you should be able to follow them on a Linux or Mac with minor modifications. + +The minimum hardware requirements for using the SDK are: +- **8 GB** RAM (preferably 16 GB or more) +- 4 CPU cores +- 20 GB free hard disk space + +The Spark SDK uses a tool called Docker to distribute all of the tools you need to build and test your trading algorithm ("Algo"). Once you have Docker installed you can download and run the latest SDK image. + +To use the Spark SDK you will need to install Docker. You don't need a C++ compiler as one is included in the spark SDK distribution. + +## Docker * Install Docker -* Install 7zip? +[Install Docker](https://www.docker.com/products/docker-desktop) +## Editor * Install an editor \ No newline at end of file diff --git a/doc/api/content/client/_index.md b/doc/api/content/client/_index.md index a73fc5490..d00ac6373 100644 --- a/doc/api/content/client/_index.md +++ b/doc/api/content/client/_index.md @@ -4,4 +4,4 @@ template="client.html" sort_by="weight" +++ -client content? + diff --git a/doc/api/content/client/getting-started/install.md b/doc/api/content/client/getting-started/install.md index ef39d20b2..2cd9902aa 100644 --- a/doc/api/content/client/getting-started/install.md +++ b/doc/api/content/client/getting-started/install.md @@ -3,5 +3,7 @@ title = "Install Prerequisites" template="client.html" weight = 1 +++ -*todo: this would have to be template="clientpage.html" + +## Coming Soon + * Install .net core diff --git a/doc/api/templates/documentation.html b/doc/api/templates/documentation.html index b3adc4df2..c0c4b4fcf 100644 --- a/doc/api/templates/documentation.html +++ b/doc/api/templates/documentation.html @@ -4,7 +4,11 @@ {% block extra_content_class %}content--reversed{% endblock extra_content_class %} {% block content %} +{%if page.extra.section %} +{% set section = get_section(path="{{page.extra.section}}/_index.md") %} +{% else %} {% set section = get_section(path="algo/_index.md") %} +{% endif %}
{% endblock content %} diff --git a/doc/api/templates/index.html b/doc/api/templates/index.html index 3501836d4..dd28c9e1a 100644 --- a/doc/api/templates/index.html +++ b/doc/api/templates/index.html @@ -27,7 +27,7 @@ About Spark
- +
diff --git a/doc/api/templates/page.html b/doc/api/templates/page.html index 8f6c09b87..bdc9d5c4d 100644 --- a/doc/api/templates/page.html +++ b/doc/api/templates/page.html @@ -5,3 +5,21 @@

{{page.title}}

{{page.content | safe}} {% endblock doc_content %} + +{% block next_link %} +

+ {% if page.lighter %} + + + Previous + + {% endif %} +   + {% if page.heavier %} + + Next + + + {% endif %} +

+{% endblock next_link %}