From e30bd3db65239cfe55ceec3f44221af140678081 Mon Sep 17 00:00:00 2001 From: Alex <alex+git@fremantle.io> Date: Wed, 28 Jul 2021 22:26:06 -0700 Subject: [PATCH] WIP: Add upcoming sections to getting started --- docs/ARCHITECTURE.md | 4 ++++ docs/GETTING_STARTED.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 3fc13e6e2..92fac0afc 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -2,6 +2,10 @@ [Getting Started](./GETTING_STARTED.md) | [Built with Tai](./BUILT_WITH_TAI.md) | [Commands](./COMMANDS.md) | [Architecture](./ARCHITECTURE.md) | [Examples](../apps/examples/README.md) | [Configuration](./CONFIGURATION.md) | [Observability](./OBSERVABILITY.md) +## Tai Components & Data Flow + +* Coming soon... + ## Orders  diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index d3429e380..a9c22a48a 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -37,6 +37,18 @@ * [https://github.com/fremantle-industries/tai#install](https://github.com/fremantle-industries/tai#install) * [https://github.com/fremantle-industries/tai/blob/main/docs/CONFIGURATION.md](https://github.com/fremantle-industries/tai/blob/main/docs/CONFIGURATION.md) +## Tai Components & Data Flow + +* [https://github.com/fremantle-industries/tai/blob/main/docs/ARCHITECTURE.md#tai-components--data-flow](https://github.com/fremantle-industries/tai/blob/main/docs/ARCHITECTURE.md#tai-components--data-flow) + +## Daily Developer Workflow + +* Coming soon... + +## Mapping Tai to OTP Concepts + +* Coming soon... + ## Streaming Order Book & Trade Data to Advisors * [https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/log_spread](https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/log_spread) @@ -45,6 +57,14 @@ * [https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/ping_pong](https://github.com/fremantle-industries/tai/tree/main/apps/examples/lib/examples/ping_pong) +## Receiving Custom Data in Advisors + +* Coming soon... + +## Testing Advisors + +* Coming soon... + ## Create and Test a New Venue Adapter * Create or use an [existing Elixir client library](https://github.com/fremantle-industries/ex_ftx) for the venue. This will help with mocks when testing @@ -59,3 +79,11 @@ * Implement [amend bulk orders](../apps/tai/lib/tai/venue_adapters/stub.ex#L34) if the venue supports changing multiple orders in place * Configure the new venue for [market data streaming](../config/runtime.exs#L51) * Configure the [account credentials](../config/runtime.exs#L86) to receive balances and manage orders + +## Coordinate Multiple Instances of Tai within an OTP Distribution Cluster + +* Coming soon... + +## Build an OTP Release and Deploy to the Cloud + +* Coming soon...