Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tarnadas committed Sep 16, 2024
1 parent 4f2d7e1 commit f977f0a
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,25 @@
# Orderly Docs

Documentation on Orderly Network.
Documentation of Orderly Network.

Suggestions and edits welcome through Pull Requests / Issues.

# Edit Approvals
Changes for new chains, new listings and minor changes that don't involve OpenAPI spec changes will be approved and merged by Jacob.

For major changes with openAPI spec file changes, Slava to approve the PR.

SDK changes and merges are approved by Mario.

## Change SOP

### New chains:
### New chains

- add contract addresses: https://orderly.network/docs/build-on-evm/addresses
- add chain here: https://orderly.network/docs/introduction/trade-on-orderly/supported-chains

### New listings:
### New listings

- add market here: https://orderly.network/docs/introduction/trade-on-orderly/supported-markets
- add exchanges for new market: https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/mark-price-index-price-and-last-price
- add funding for the pairL https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/funding-rate
- add funding for the pair: https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/funding-rate
- add margin for the pair: https://orderly.network/docs/introduction/trade-on-orderly/perpetual-futures/margin-leverage-and-pnl

### New broker:
### New broker

- add broker under "/introduction/trade-on-orderly/brokers.mdx"

## API or nav changes that require mint.json edit need to run "Update script"
Expand All @@ -43,7 +39,6 @@ In order to run the script, do the following:
- Install dependencies via: `yarn`
- Run update script: `yarn update`


<Note>
Pre-release changes will be pushed to staging branch. Staging will be merged to main once the release is complete and all changes are in production.
</Note>
Expand Down

0 comments on commit f977f0a

Please sign in to comment.