Omar zamel docs ftp

README.md

@@ -16,6 +16,15 @@ $ yarn start
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
+### Multilanguage Development(i18n)
+
+```
+$ yarn build
+$ yarn serve
+```
+
+This command generates static content includes multilanguage feature(i18n).And it starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
 ### Build
 
 ```

docs/Concepts Explained/Charts.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 6
+---
+
+# Charts
+
+The charting technology is provided by TradingView, a platform for traders and investors especially valued by crypto enthusiasts: it lets you dive into versatile research with high-performance tools and data like [BTC USD](https://www.tradingview.com/symbols/BTCUSD/) price and other key stats, to stay up-to-date on where the markets are moving.

docs/Concepts Explained/How is Overlay different.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 1
+---
+
+# How is Overlay Different
+
+
+## What are perpetual futures contracts or perps?
+
+Perps are the most popular type of derivative contract in crypto markets. Perps allow a user to take a long or short position on an underlying asset without owning it, while either paying or receiving funding to carry on the position (depending on market conditions and the side a user is on). 
+
+Perps differ from traditional futures contracts in that there is no date of expiry/settlement or delivery of the underlying asset. Perp contracts keep rolling over in perpetuity till a user decides to close their position. 
+
+Typically, whitelisted assets are used as margin/collateral for these positions and users are allowed to take on leverage (sometimes up to a 100x). If the margin requirements fall below the minimum threshold, the collateral is liquidated.
+
+Contracts on Overlay markets resemble perpetual future contracts in that there is no date of expiry (contracts can keep rolling over), and that there is no delivery of the underlying asset. However, there are some key features of contracts on Overlay markets that differ from traditional perps - these are discussed below.
+
+
+## Oracle-based pricing
+
+Overlay brings in data points, which act as a proxy for price by using a combination of oracle-based feeds and native mechanisms to determine the data point of a feed that users can build positions on. For more details, please check out our [detailed doc on pricing](/Concepts%20Explained/Pricing%20and%20Price%20Impact). 
+
+Traditional crypto exchanges like Binance usually use a centralized limit order book (CLOB) system to determine price. Price is based on matching of orders in the buy side and sell side of the order book - price is determined merely by what the asset was last bought for. 
+
+Certain on-chain perp protocols like Perp Protocol and GMX also use oracle based feeds for pricing. 
+
+
+## Lack of traditional counterparties
+
+Overlay will offer tradable markets to its users without traditional counterparties taking the other side of a position. Overlay dynamically mints/burns its native token OVL when a position is closed:
+
+(i) if a positive delta is realized, the protocol mints OVL according to the delta difference against the users initial collateral (also denoted in OVL)
+
+(ii) if a negative delta is realized, a percent of collateral put up by the user (in the form of OVL) is burnt
+
+Risk of inflation is a potential risk for passive OVL holders, and should be understood by users of the system. To know more about how risks and how Overlay addresses risk, please refer to [Summary of Risks](/Security/Risks).
+
+Traditional CLOB-based crypto exchanges rely on swap-based counterparties (including market makers) in order to provide liquidity into their markets. On-chain derivative protocols like Perp Protocol and GMX use liquidity providers to seed liquidity into liquidity pools that users then trade against.
+
+
+## No Limit Orders
+
+Overlay v1 will not support setting bids and asks via limit orders. At this time, only market orders will be executable on Overlay markets. Generally, CLOB based and LP based exchanges have limit orders.
+
+
+## Funding
+
+Funding rates refer to the periodic fees paid by a trader to hold a long or short position using perps. This can also be thought of as a ‘premium’ that is paid in traditional markets to hold certain futures/options positions. 
+
+Funding rate mechanisms allow CLOB-based exchanges to get the futures price of an asset in line with the underlying spot price of the asset (and reduce the basis). Liquidity provider based trading platforms like GMX and Perp Protocol utilize funding payments in order to pay out yield to liquidity providers in return for providing liquidity.
+
+For Overlay, funding rates are calculated based on the imbalance in Open Interest, rather than the imbalance between spot and future prices. Funding rates on Overlay are mainly utilized to lessen the imbalance between longs and shorts, incentivizing users to come into the lagging side to reduce the imbalance.
+
+
+## PnL and Collateral
+
+Users would be required to lock OVL as collateral to a position in an Overlay market. PnL will also be paid out in OVL. OVL is minted by the protocol and paid out to the user as PnL if a position delta positive; on the other hand, if the position is delta negative, locked OVL is burned (to the extent of the loss).

docs/Concepts Explained/OI caps and other caps.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 4
+---
+
+# Payoff caps, OI caps, and the Circuit Breaker
+
+
+## Introduction
+
+Overlay uses its native token OVL to pay out PnL if there is a loss, and burns OVL collateralized by the user (up to the extent of the loss) in case of a loss. While this mechanism bestows the protocol with benefits like not requiring market makers or the ability to open positions on nearly any scalar data stream, it also opens the protocol up to potential vulnerabilities caused by OVL inflation (especially in case of long-tail assets).
+
+To counter these potential vulnerabilities, Overlay utilizes a risk framework that includes payoff caps, OI caps, and a circuit breaker mechanism.
+
+
+## Payoff caps
+
+Payoff caps (denoted as _C<sub>p</sub>_) are a “per-position” limit on the PnL of each position. This is a static cap that will be determined by the DAO through a formal governance process and will be specific to each market on Overlay. With riskier/longer tail assets, governance could choose a lower cap.
+
+In markets based on long tail price feeds, the payoff cap enables: 
+
+(i) the protocol to avoid a theoretically infinite payout on any particular position; and 
+
+(ii) the protocol to quantify the risk associated with each market in an automated fashion, based on the _C<sub>p</sub>_ determined by the DAO
+
+
+## Open Interest caps
+
+Open Interest caps (OI caps or C<sub>Q</sub> are “per-market” caps that set a cut off or limit on the aggregate amount of open interest (on the long and short side) in Overlay markets. This static constant will vary from market to market, and will be determined by the community through governance. OI caps are required despite the existence of payoff caps as payoff caps may be bypassed by a user by opening multiple positions. 
+
+Setting C<sub>Q</sub> through governance helps the protocol quantify inflation risk: the amount of OVL that the protocol will have to mint in case of a worst-case scenario for any given market. This hypothetical worst-case scenario involves the imbalance liability (the difference in OI between longs and shorts) being completely skewed towards one side of the market. Quantifying the per-market inflation risk (a function of C<sub>Q</sub>) in the worst-case scenario in an automated fashion allows the community to be aware of the risks posed to the protocol by the introduction of any new market. 
+
+
+## Circuit Breaker
+
+The circuit breaker mechanism gives Overlay an extra layer of protection: it allows a market to cool off in case there have been large payouts (in the form of OVL printing) during the recent past. 
+
+Using C<sub>Q</sub>, the protocol calculates an expected inflation rate over a rolling period of time. If the actual inflation rate in this period exceeds the expected rate, C<sub>Q </sub>is adjusted to stem the inflation. C<sub>Q </sub>comes back to normal when the actual inflation rate nears the expected inflation rate. 
+
+The circuit breaker works by adjusting the per-market notional OI cap (C<sub>Q</sub>) for a particular period of time so as to limit the possible notional size of new positions offered by the market till the market cools down. 
+
+<p style={{textAlign: 'right'}}>
+<em>Last updated on <strong>Dec 19, 2023</strong></em></p>
+

docs/Concepts Explained/OVL.md

@@ -1,3 +1,37 @@
 ---
-sidebar_position: 4
----
+sidebar_position: 2
+---
+# OVL
+
+OVL is the proposed native token of Overlay Protocol. It is an ERC-20 token. OVL serves a dual purpose and will be used to participate in trading and DAO governance after launch.
+
+OVL may be used by holders to:
+
+
+
+1. vote on [governance](/Getting%20Started/Governance) proposals of the DAO governing Overlay Protocol
+2. open positions on the markets offered on Overlay by using OVL as collateral
+
+
+## Token Details
+
+| Ticker | OVL |
+| :----------- | :----------- |
+| Initial Supply | 88,888,888 |
+
+## Building Position
+
+To enter a position, a user of Overlay Protocol will lock OVL into the Overlay smart contract as collateral/margin. A user could leverage this collateral on either side of any market offered by Overlay. 
+
+On closing a position, the position could either be profitable, unprofitable or at a break even. If the position is profitable, the protocol will mint OVL tokens equivalent to the delta difference of the market between build and unwind. These tokens are added to the circulating supply of OVL. 
+
+If the position is unprofitable, the protocol burns OVL tokens of a value equivalent to the loss sustained. These tokens are removed from the circulating supply of OVL. No tokens are minted or burned in case a position is closed at a break even.  
+
+
+## Supply
+
+Total supply of OVL will be 88,888,888. The OVL supply, by function, is dynamic. Thus, OVL will be dynamically minted and burned by the smart contracts when positions are unwound by users.
+
+<p style={{textAlign: 'right'}}>
+<em>Last updated on <strong>Jan 2, 2025</strong></em></p>
+

docs/Concepts Explained/Oracles.md

@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Oracles
+
+Pricing data on Overlay markets is based on values intermittently fetched from oracles. Oracles are services that help protocols get information/data (related to price data or other data) required from outside of the protocol’s smart contract ecosystem. Any tool that helps get price data about an asset is a “price oracle.” Overlay has the ability to onboard nearly any oracle, as long as the oracle feed is non-manipulable and non-predictable.