Docs mini-guide

Here's a quick reference about what changes you need to make to the package description and documentation when adding new content.

New exchange

When adding a new exchange to the package, you need to make the following changes:

README.md

In the Supported Exchange APIs table in the README.md you need to add a new row with links to relevant resources:

...
<tr>
    <td><img src="docs/src/assets/EXCHANGE_LOGO.png" alt="Exchange Logo" width="20" height="20"></td>
    <td><a href="https://EXCHANGE_LINK">EXCHANGE_NAME</a></td>
    <td><a href="https://EXCHANGE_MARKET_LINK">MARKET_TYPE</a></td>
    <td><a href="src/EXCHANGE_NAME/MARKET_TYPE">CryptoExchangeAPIs.EXCHANGE_NAME.MARKET_TYPE</a></td>
    <td><a href="https://bhftbootcamp.github.io/CryptoExchangeAPIs.jl/stable/pages/EXCHANGE_NAME/#MARKET_TYPE">MARKET_TYPE</a></td>
</tr>
...

docs/src/index.md

Similarly, add a new line to the table on the main documentation page in the file docs/src/index.md (the only difference will be the path of the logo: <img src="assets/EXCHANGE_LOGO.png" ...>).

...
<tr>
    <td><img src="assets/EXCHANGE_LOGO.png" alt="Exchange Logo" width="20" height="20"></td>
    <td><a href="https://EXCHANGE_LINK">EXCHANGE_NAME</a></td>
    <td><a href="https://EXCHANGE_MARKET_LINK">MARKET_TYPE</a></td>
    <td><a href="src/EXCHANGE_NAME/MARKET_TYPE">CryptoExchangeAPIs.EXCHANGE_NAME.MARKET_TYPE</a></td>
    <td><a href="https://bhftbootcamp.github.io/CryptoExchangeAPIs.jl/stable/pages/EXCHANGE_NAME/#MARKET_TYPE">MARKET_TYPE</a></td>
</tr>
...

src/EXCHANGE_NAME/EXCHANGE_NAME.jl

Add a docstring describing key types and methods (clients, errors, etc.).

docs/src/pages/EXCHANGE_NAME.md

Create a new documentation page in the docs/src/pages/ folder in markdown format with the appropriate exchange name, for example docs/src/pages/Binance.md. The documentation page should have the following section structure:

# EXCHANGE_NAME

```@docs
CryptoExchangeAPIs.EXCHANGE_NAME.<...>
<!-- Here list everything that is directly related to the
general description of the exchange (clients, errors, etc.) -->
```

<!-- Sections related to exchange markets begin here -->

New market

When adding a new market type for an exchange, you need to make the following changes:

README.md and docs/src/index.md

Similar to adding a new exchange, you need to add a new row to the table with Supported Exchange APIs (in the README.md and on the main page of the documentation docs/src/index.md) corresponding to the new type of market.

src/EXCHANGE_NAME/MARKET_TYPE/MARKET_TYPE.jl

Add a docstring describing key types and methods related to the market (public client, etc.).

docs/src/pages/EXCHANGE_NAME.md

Add a new section corresponding to the exchange market in the file docs/src/pages/EXCHANGE_NAME.md:

## MARKET_TYPE

```@docs
CryptoExchangeAPIs.EXCHANGE_NAME.MARKET_TYPE.<...>
<!-- Here list everything that is related to the market (public client, etc.) -->
```

```@docs
CryptoExchangeAPIs.EXCHANGE_NAME.MARKET_TYPE.<...>
<!-- Here list the API methods for the market -->
```

New API method

src/EXCHANGE_NAME/MARKET_TYPE/API/METHOD_NAME.jl

When adding a new API method, it is enough to add a docstring with a description of the method according to template.

docs/src/pages/EXCHANGE_NAME.md

After that, add the method to the section of the corresponding market in the documentation (in the file docs/src/pages/EXCHANGE_NAME.md):

## MARKET_TYPE

...

```@docs
CryptoExchangeAPIs.EXCHANGE_NAME.MARKET_TYPE.<...>
<!-- Here list the API methods for the market -->
```

Template for API method docs

"""
    METHOD_NAME(client::EXCHANGE_CLIENT, query::METHOD_QUERY)
    METHOD_NAME(client::EXCHANGE_CLIENT = EXCHANGE_MODULE.SUB_MODULE.public_client; kw...)

DESCRIPTION.

[`GET HTTP_REQUEST`](METHOD_URL)

## Parameters:

| Parameter | Type     | Required | Description |
|:----------|:---------|:---------|:------------|
| name      | type     | bool     | description |

## Code samples:

```julia
using Serde
using CryptoExchangeAPIs.EXCHANGE_MODULE

result = EXCHANGE_MODULE.SUB_MODULE.METHOD_NAME(;
    ...
)

to_pretty_json(result.result)
```

## Result:

```json
{
    JSON_RESULT
}
```
"""

Example

README.md

## Supported Exchange APIs

<html>
    <body>
        <table>
            <tr>
                <th>#</th>
                <th>Exchange</th>
                <th>API Documentation</th>
                <th>Module</th>
                <th>Documentation</th>
            </tr>
            ...
            <tr>
                <td><img src="docs/src/assets/binance.png" alt="Binance Logo" width="20" height="20"></td>
                <td><a href="https://www.binance.com/en/trade">Binance</a></td>
                <td><a href="https://binance-docs.github.io/apidocs/spot/en/">Spot</a></td>
                <td><a href="src/Binance/Spot">CryptoExchangeAPIs.Binance.Spot</a></td>
                <td><a href="https://bhftbootcamp.github.io/CryptoExchangeAPIs.jl/stable/pages/Binance/#Spot">Spot</a></td>
            </tr>
            ...
        </table>
    </body>
</html>

docs/src/index.md

## Supported Exchange APIs

```@raw html
<html>
    <body>
        <table>
            <tr>
                <th>#</th>
                <th>Exchange</th>
                <th>API Documentation</th>
                <th>Module</th>
                <th>Documentation</th>
            </tr>
            ...
            <tr>
                <td><img src="assets/binance.png" alt="Binance Logo" width="20" height="20"></td>
                <td><a href="https://www.binance.com/en/trade">Binance</a></td>
                <td><a href="https://binance-docs.github.io/apidocs/spot/en/">Spot</a></td>
                <td><a href="src/Binance/Spot">CryptoExchangeAPIs.Binance.Spot</a></td>
                <td><a href="https://bhftbootcamp.github.io/CryptoExchangeAPIs.jl/stable/pages/Binance/#Spot">Spot</a></td>
            </tr>
            ...
        </table>
    </body>
</html>
```

docs/src/pages/EXCHANGE_NAME.md

# Binance

```@docs
CryptoExchangeAPIs.Binance.BinanceClient
CryptoExchangeAPIs.Binance.BinanceAPIError
```

## Spot

```@docs
CryptoExchangeAPIs.Binance.Spot.public_client
```

```@docs
CryptoExchangeAPIs.Binance.Spot.candle
CryptoExchangeAPIs.Binance.Spot.avg_price
...
```

## USDMFutures

```@docs
CryptoExchangeAPIs.Binance.USDMFutures.public_client
```

```@docs
CryptoExchangeAPIs.Binance.USDMFutures.candle
CryptoExchangeAPIs.Binance.USDMFutures.exchange_info
...
```