Skip to content

Commit 2dcaa2b

Browse files
committed
Improve docs consistency
1 parent 3d68738 commit 2dcaa2b

File tree

10 files changed

+60
-60
lines changed

10 files changed

+60
-60
lines changed

docs/concepts/architecture.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Throughout the documentation, the term *"Nautilus system boundary"* refers to op
1818
the runtime of a single Nautilus node (also known as a "trader instance").
1919
:::
2020

21-
## Design philosophy
21+
## Design Philosophy
2222

2323
The major architectural techniques and design patterns employed by NautilusTrader are:
2424

@@ -30,7 +30,7 @@ The major architectural techniques and design patterns employed by NautilusTrade
3030

3131
These techniques have been utilized to assist in achieving certain architectural quality attributes.
3232

33-
### Quality attributes
33+
### Quality Attributes
3434

3535
Architectural decisions are often a trade-off between competing priorities. The
3636
below is a list of some of the most important quality attributes which are considered
@@ -43,7 +43,7 @@ when making design and architectural decisions, roughly in order of 'weighting'.
4343
- Maintainability
4444
- Deployability
4545

46-
## System architecture
46+
## System Architecture
4747

4848
The NautilusTrader codebase is actually both a framework for composing trading
4949
systems, and a set of default system implementations which can operate in various
@@ -110,7 +110,7 @@ Provides comprehensive risk management:
110110
- Real-time risk calculations.
111111
- Configurable risk rules and limits.
112112

113-
### Environment contexts
113+
### Environment Contexts
114114

115115
An environment context in NautilusTrader defines the type of data and trading venue you are working
116116
with. Understanding these contexts is crucial for effective backtesting, development, and live trading.
@@ -121,7 +121,7 @@ Here are the available environments you can work with:
121121
- `Sandbox`: Real-time data with simulated venues.
122122
- `Live`: Real-time data with live venues (paper trading or real accounts).
123123

124-
### Common core
124+
### Common Core
125125

126126
The platform has been designed to share as much common code between backtest, sandbox and live trading systems as possible.
127127
This is formalized in the `system` subpackage, where you will find the `NautilusKernel` class,

docs/concepts/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ have all been written entirely in [Rust](https://www.rust-lang.org/) or [Cython]
5555
This means we're using the right tools for the job, where systems programming languages compile performant binaries,
5656
with CPython C extension modules then able to offer a Python-native environment, suitable for professional quantitative traders and trading firms.
5757

58-
## Use cases
58+
## Use Cases
5959

6060
There are three main use cases for this software package:
6161

@@ -80,7 +80,7 @@ include the application and infrastructure layers.
8080
The platform is designed to be easily integrated into a larger distributed system.
8181
To facilitate this, nearly all configuration and domain objects can be serialized using JSON, MessagePack or Apache Arrow (Feather) for communication over the network.
8282

83-
## Common core
83+
## Common Core
8484

8585
The common system core is utilized by all node [environment contexts](/concepts/architecture.md#environment-contexts) (`backtest`, `sandbox`, and `live`).
8686
User-defined `Actor`, `Strategy` and `ExecAlgorithm` components are managed consistently across these environment contexts.
@@ -90,7 +90,7 @@ User-defined `Actor`, `Strategy` and `ExecAlgorithm` components are managed cons
9090
Backtesting can be achieved by first making data available to a `BacktestEngine` either directly or via
9191
a higher level `BacktestNode` and `ParquetDataCatalog`, and then running the data through the system with nanosecond resolution.
9292

93-
## Live trading
93+
## Live Trading
9494

9595
A `TradingNode` can ingest data and events from multiple data and execution clients.
9696
Live deployments can use both demo/paper trading accounts, or real accounts.
@@ -100,7 +100,7 @@ The platform supports both demo/paper trading accounts and real accounts. High p
100100
asynchronously on a single [event loop](https://docs.python.org/3/library/asyncio-eventloop.html),
101101
with the potential to further boost performance by leveraging the [uvloop](https://github.com/MagicStack/uvloop) implementation (available for Linux and macOS).
102102

103-
## Domain model
103+
## Domain Model
104104

105105
The platform features a comprehensive trading domain model that includes various value types such as
106106
`Price` and `Quantity`, as well as more complex entities such as `Order` and `Position` objects,
@@ -142,7 +142,7 @@ Example: `2d89666b-1a1e-4a75-b193-4eb3b454c757`
142142

143143
For the complete specification, refer to [RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace](https://datatracker.ietf.org/doc/html/rfc4122).
144144

145-
## Data types
145+
## Data Types
146146

147147
The following market data types can be requested historically, and also subscribed to as live streams when available from a venue / data provider, and implemented in an integrations adapter.
148148

@@ -163,7 +163,7 @@ The following `PriceType` options can be used for bar aggregations:
163163
- `MID`
164164
- `LAST`
165165

166-
## Bar aggregations
166+
## Bar Aggregations
167167

168168
The following `BarAggregation` methods are available:
169169

docs/developer_guide/environment_setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@ docker-compose up -d postgres
142142

143143
Used services are:
144144

145-
- `postgres`: Postgres database with root user `POSTRES_USER` which defaults to `postgres`, `POSTGRES_PASSWORD` which defaults to `pass` and `POSTGRES_DB` which defaults to `postgres`
146-
- `redis`: Redis server
147-
- `pgadmin`: PgAdmin4 for database management and administration
145+
- `postgres`: Postgres database with root user `POSTRES_USER` which defaults to `postgres`, `POSTGRES_PASSWORD` which defaults to `pass` and `POSTGRES_DB` which defaults to `postgres`.
146+
- `redis`: Redis server.
147+
- `pgadmin`: PgAdmin4 for database management and administration.
148148

149149
:::info
150150
Please use this as development environment only. For production, use a proper and more secure setup.
@@ -217,8 +217,8 @@ POSTGRES_DATABASE=nautilus
217217

218218
List of commands are:
219219

220-
1. `nautilus database init`: Will bootstrap schema, roles and all sql files located in `schema` root directory (like `tables.sql`)
221-
2. `nautilus database drop`: Will drop all tables, roles and data in target Postgres database
220+
1. `nautilus database init`: Will bootstrap schema, roles and all sql files located in `schema` root directory (like `tables.sql`).
221+
2. `nautilus database drop`: Will drop all tables, roles and data in target Postgres database.
222222

223223
## Rust analyzer settings
224224

docs/integrations/betfair.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,15 @@ Betfair operates as a betting exchange with unique characteristics compared to t
9191
| `FOK` | - | Betting exchange uses different model. |
9292
| `IOC` | - | Betting exchange uses different model. |
9393

94-
### Advanced order features
94+
### Advanced Order Features
9595

9696
| Feature | Betfair | Notes |
9797
|--------------------|---------|------------------------------------------|
9898
| Order Modification || Limited to non-exposure changing fields. |
9999
| Bracket/OCO Orders | - | *Not supported*. |
100100
| Iceberg Orders | - | *Not supported*. |
101101

102-
### Configuration options
102+
### Configuration Options
103103

104104
The following execution client configuration options affect order behavior:
105105

docs/integrations/binance.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Most users will simply define a configuration for a live trading node (as below)
6363
and won't need to necessarily work with these lower level components directly.
6464
:::
6565

66-
## Data types
66+
## Data Types
6767

6868
To provide complete API functionality to traders, the integration includes several
6969
custom data types:
@@ -125,15 +125,15 @@ Only *limit* order types support `post_only`.
125125
| `FOK` ||||| Fill or Kill. |
126126
| `IOC` ||||| Immediate or Cancel. |
127127

128-
### Advanced order features
128+
### Advanced Order Features
129129

130130
| Feature | Spot | Margin | USDT Futures | Coin Futures | Notes |
131131
|--------------------|------|--------|--------------|--------------|----------------------------------------------|
132132
| Order Modification ||||| Price and quantity for `LIMIT` orders only. |
133133
| Bracket/OCO Orders ||||| One-Cancels-Other for stop loss/take profit. |
134134
| Iceberg Orders ||||| Large orders split into visible portions. |
135135

136-
### Configuration options
136+
### Configuration Options
137137

138138
The following execution client configuration options affect order behavior:
139139

@@ -146,7 +146,7 @@ The following execution client configuration options affect order behavior:
146146
| `futures_leverages` | `None` | Dict to set initial leverage per symbol for Futures accounts. |
147147
| `futures_margin_types` | `None` | Dict to set margin type (isolated/cross) per symbol for Futures accounts. |
148148

149-
### Trailing stops
149+
### Trailing Stops
150150

151151
Binance uses the concept of an activation price for trailing stops, as detailed in their [documentation](https://www.binance.com/en/support/faq/what-is-a-trailing-stop-order-360042299292).
152152
This approach is somewhat unconventional. For trailing stop orders to function on Binance, the activation price should be set using the `activation_price` parameter.
@@ -223,7 +223,7 @@ node.add_exec_client_factory(BINANCE, BinanceLiveExecClientFactory)
223223
node.build()
224224
```
225225

226-
### API credentials
226+
### API Credentials
227227

228228
There are two options for supplying your credentials to the Binance clients.
229229
Either pass the corresponding `api_key` and `api_secret` values to the configuration objects, or
@@ -267,7 +267,7 @@ using the `BinanceAccountType` enum. The account type options are:
267267
We recommend using environment variables to manage your credentials.
268268
:::
269269

270-
### Base url overrides
270+
### Base URL Overrides
271271

272272
It's possible to override the default base URLs for both HTTP Rest and
273273
WebSocket APIs. This is useful for configuring API clusters for performance reasons,
@@ -308,7 +308,7 @@ config = TradingNodeConfig(
308308
)
309309
```
310310

311-
### Aggregated trades
311+
### Aggregated Trades
312312

313313
Binance provides aggregated trade data endpoints as an alternative source of trades.
314314
In comparison to the default trade endpoints, aggregated trade data endpoints can return all
@@ -317,7 +317,7 @@ ticks between a `start_time` and `end_time`.
317317
To use aggregated trades and the endpoint features, set the `use_agg_trade_ticks` option
318318
to `True` (this is `False` by default.)
319319

320-
### Parser warnings
320+
### Parser Warnings
321321

322322
Some Binance instruments are unable to be parsed into Nautilus objects if they
323323
contain enormous field values beyond what can be handled by the platform.
@@ -337,15 +337,15 @@ instrument_provider=InstrumentProviderConfig(
337337
)
338338
```
339339

340-
### Futures Hedge mode
340+
### Futures Hedge Mode
341341

342342
Binance Futures Hedge mode is a position mode where a trader opens positions in both long and short
343343
directions to mitigate risk and potentially profit from market volatility.
344344

345345
To use Binance Future Hedge mode, you need to follow the three items below:
346346

347347
- 1. Before starting the strategy, ensure that hedge mode is configured on Binance.
348-
- 2. Set the `use_reduce_only` option to `False` in BinanceExecClientConfig (this is `True` by default.)
348+
- 2. Set the `use_reduce_only` option to `False` in BinanceExecClientConfig (this is `True` by default).
349349

350350
```python
351351
from nautilus_trader.adapters.binance import BINANCE
@@ -428,8 +428,8 @@ subscription will be used by the Binance data client.
428428

429429
Order book snapshot rebuilds will be triggered on:
430430

431-
- Initial subscription of the order book data
432-
- Data websocket reconnects
431+
- Initial subscription of the order book data.
432+
- Data websocket reconnects.
433433

434434
The sequence of events is as follows:
435435

docs/integrations/bybit.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,15 @@ All the order types listed below can be used as *either* entries or exits, excep
119119
| `FOK` |||| Fill or Kill. |
120120
| `IOC` |||| Immediate or Cancel. |
121121

122-
### Advanced order features
122+
### Advanced Order Features
123123

124124
| Feature | Spot | Linear | Inverse | Notes |
125125
|--------------------|------|--------|---------|----------------------------------------|
126126
| Order Modification |||| Price and quantity modification. |
127127
| Bracket/OCO Orders |||| UI only; API users implement manually. |
128128
| Iceberg Orders |||| Max 10 per account, 1 per symbol. |
129129

130-
### Configuration options
130+
### Configuration Options
131131

132132
The following execution client configuration options affect order behavior:
133133

@@ -147,7 +147,7 @@ The following limitations apply to SPOT products, as positions are not tracked o
147147
- `reduce_only` orders are *not supported*.
148148
- Trailing stop orders are *not supported*.
149149

150-
### Trailing stops
150+
### Trailing Stops
151151

152152
Trailing stops on Bybit do not have a client order ID on the venue side (though there is a `venue_order_id`).
153153
This is because trailing stops are associated with a netted position for an instrument.
@@ -162,11 +162,11 @@ Consider the following points when using trailing stops on Bybit:
162162

163163
The product types for each client must be specified in the configurations.
164164

165-
### Data clients
165+
### Data Clients
166166

167167
If no product types are specified then all product types will be loaded and available.
168168

169-
### Execution clients
169+
### Execution Clients
170170

171171
Because Nautilus does not support a "unified" account, the account type must be either cash **or** margin.
172172
This means there is a limitation that you cannot specify SPOT with any of the other derivative product types.
@@ -225,7 +225,7 @@ node.add_exec_client_factory(BYBIT, BybitLiveExecClientFactory)
225225
node.build()
226226
```
227227

228-
### API credentials
228+
### API Credentials
229229

230230
There are two options for supplying your credentials to the Bybit clients.
231231
Either pass the corresponding `api_key` and `api_secret` values to the configuration objects, or

docs/integrations/coinbase_intx.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ The WebSocket client handles automatic reconnection and re-subscribes to active
103103

104104
**The adapter is designed to trade one Coinbase International portfolio per execution client.**
105105

106-
### Selecting a portfolio
106+
### Selecting a Portfolio
107107

108108
To identify your available portfolios and their IDs, use the REST client by running the following script:
109109

@@ -128,7 +128,7 @@ This will output a list of portfolio details, similar to the example below:
128128
'user_uuid': 'd4fbf7ea-9515-1068-8d60-4de91702c108'}]
129129
```
130130

131-
### Configuring the portfolio
131+
### Configuring the Portfolio
132132

133133
To specify a portfolio for trading, set the `COINBASE_INTX_PORTFOLIO_ID` environment variable to
134134
the desired `portfolio_id`. If you're using multiple execution clients, you can alternatively define
@@ -166,15 +166,15 @@ Coinbase International offers market, limit, and stop order types, enabling a br
166166
| `FOK` ||| Fill or Kill. |
167167
| `IOC` ||| Immediate or Cancel. |
168168

169-
### Advanced order features
169+
### Advanced Order Features
170170

171171
| Feature | Derivatives | Spot | Notes |
172172
|--------------------|-------------|------|---------------------------------------------|
173173
| Order Modification ||| Price and quantity modification. |
174174
| Bracket/OCO Orders | ? | ? | Requires further investigation. |
175175
| Iceberg Orders ||| Available via FIX protocol. |
176176

177-
### Configuration options
177+
### Configuration Options
178178

179179
The following execution client configuration options are available:
180180

@@ -183,7 +183,7 @@ The following execution client configuration options are available:
183183
| `portfolio_id` | `None` | Specifies the Coinbase International portfolio to trade. Required for execution. |
184184
| `http_timeout_secs` | `60` | Default timeout for HTTP requests in seconds. |
185185

186-
### FIX Drop Copy integration
186+
### FIX Drop Copy Integration
187187

188188
The Coinbase International adapter includes a FIX (Financial Information eXchange) [drop copy](https://docs.cdp.coinbase.com/intx/docs/fix-msg-drop-copy) client.
189189
This provides reliable, low-latency execution updates directly from Coinbase's matching engine.
@@ -210,7 +210,7 @@ No additional configuration is required beyond providing valid API credentials.
210210
The REST client handles processing `REJECTED` and `ACCEPTED` status execution messages on order submission.
211211
:::
212212

213-
### Account and position management
213+
### Account and Position Management
214214

215215
On startup, the execution client requests and loads your current account and execution state including:
216216

@@ -277,7 +277,7 @@ node.add_exec_client_factory(COINBASE_INTX, CoinbaseIntxLiveExecClientFactory)
277277
node.build()
278278
```
279279

280-
### API credentials
280+
### API Credentials
281281

282282
Provide credentials to the clients using one of the following methods.
283283

docs/integrations/dydx.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,15 +161,15 @@ dYdX supports perpetual futures trading with a comprehensive set of order types
161161
| `FOK` || Fill or Kill. |
162162
| `IOC` || Immediate or Cancel. |
163163

164-
### Advanced order features
164+
### Advanced Order Features
165165

166166
| Feature | Perpetuals | Notes |
167167
|--------------------|------------|-------------------------------------------------|
168168
| Order Modification || Short-term orders only; cancel-replace method. |
169169
| Bracket/OCO Orders | - | *Not supported*. |
170170
| Iceberg Orders | - | *Not supported*. |
171171

172-
### Configuration options
172+
### Configuration Options
173173

174174
The following execution client configuration options are available:
175175

@@ -191,7 +191,7 @@ dYdX classifies orders as either **short-term** or **long-term** orders:
191191

192192
The product types for each client must be specified in the configurations.
193193

194-
### Execution clients
194+
### Execution Clients
195195

196196
The account type must be a margin account to trade the perpetual futures contracts.
197197

@@ -239,7 +239,7 @@ node.add_exec_client_factory("DYDX", DYDXLiveExecClientFactory)
239239
node.build()
240240
```
241241

242-
### API credentials
242+
### API Credentials
243243

244244
There are two options for supplying your credentials to the dYdX clients.
245245
Either pass the corresponding `wallet_address` and `mnemonic` values to the configuration objects, or
@@ -286,7 +286,7 @@ config = TradingNodeConfig(
286286
)
287287
```
288288

289-
### Parser warnings
289+
### Parser Warnings
290290

291291
Some dYdX instruments are unable to be parsed into Nautilus objects if they
292292
contain enormous field values beyond what can be handled by the platform.

0 commit comments

Comments
 (0)