Merge pull request #4 from VenusProtocol/add-summary-outline

feat: add summary with doc outline

Author: coreyar

README.md

@@ -0,0 +1 @@
+# Venus Protocol V4

SUMMARY.md

@@ -0,0 +1,96 @@
+# Table of contents
+
+## Getting Started
+
+* [V4 Overview](README.md)
+* [Contracts Overview](getting-started/contracts-overview.md)
+* [V4 Whitepaper]()
+* [Protocol Features Summary](getting-started/protocol-feature-summary.md)
+
+## What's New?
+
+* [Isolated Lending](whats-new/portal.md)
+* [Stable Rate Borrowing](whats-new/efficiency-mode-emode.md)
+* [VAI Stability Fee](whats-new/isolation-mode.md)
+* [Governance Routes](whats-new/siloed-borrowing.md)
+* [Supply Borrow Caps](whats-new/supply-borrow-caps.md)
+* [Integrated Swap](whats-new/integrated-swap.md)
+
+## Guides
+
+* [Supplying](guides/supplying.md)
+* [Borrowing](guides/borrowing.md)
+* [Governance Guide](guides/governance-guide/README.md)
+  * [Venus Improvement Proposal](guides/governance-guide/vip.md)
+  * [Routes](guides/governance-guide/routes.md)
+  * [Voting](guides/governance-guide/voting.md)
+  * [Delegating](guides/governance-guide/delegating.md)
+* [Contributing](guides/contributing/README.md)
+  * [Setting up a development environment](guides/contributing/development-environment.md)
+  * [Testing Guide](guides/contributing/testing-guide.md)
+* [Protocol Math](guides/protocol-math.md)
+
+
+## Core Pool
+
+* [Unitroller](core-pool/unitroller.md)
+* [VTokens](core-pool/vtokens.md)
+* [Lens](core-pool/lens.md)
+* [Oracle](core-pool/oracle.md)
+* [Liquidator](core-pool/liquidator.md)
+* [Interest Rate Model](core-pool/interest-rate-model.md)
+* [Jump Model](core-pool/jump-model.md)
+
+## Isolated Lending
+
+* [Pool Registry](isolated-lending/pool-registry.md)
+* [Pool](isolated-lending/pool.md)
+* [Rewards Distributor](isolated-lending/rewards-distributor.md)
+* [Lens](isolated-lending/lens.md)
+* [Risk Fund](isolated-lending/risk-fund/README.md)
+  * [Protocol Share Reserve](isolated-lending/risk-fund/protocol-share-reserve.md)
+  * [Shortfall](isolated-lending/risk-fund/shortfall.md)
+* [Factories](isolated-lending/factories/README.md)
+  * [Jump Rate Model](isolated-lending/factories/jump-rate-model.md)
+  * [VBep20 Immutable Proxy Factory](isolated-lending/factories/VBep20-mmutable-proxy-factory)
+  * [White Paper Interest Rate Model Factory](isolated-lending/factories/white-paper-interest-rate-model-factory.md)
+
+## Oracles
+
+* [Resiliant Oracle](isolated-lending/resiliant-oracle.md)
+* [Chainlink](isolated-lending/chainlink.md)
+* [Pyth](isolated-lending/pyth.md)
+* [Binance](isolated-lending/binance.md)
+* [TWAP](isolated-lending/twap.md)
+
+## Governance
+* [Bravo](governance/bravo.md)
+  * [Proposals](governance/proposals.md)
+  * [Voting](governance/voting.md)
+  * [Delegating](governance/delegating.md)
+  * [Routes](governance/routes.md)
+* [Access Control Manager](isolated-lending/access-control-manager.md)
+
+## Vaults
+
+* [XVS Vault](vaults/xvs-vault.md)
+* [VAI Vault](vaults/vai-vault.md)
+* [VRT Vault](vaults/vrt-vault.md)
+
+## Tokens
+
+* [VAI](tokens/vai.md)
+* [XVS](tokens/xvs.md)
+* [VRT](tokens/vrt.md)
+
+
+## Deployed Contracts
+
+* [V4 Testnet Addresses](deployed-coxntracts/v4-testnet.md)
+* [V4 Mainnet](deployed-contracts/v4-mainnet/README.md)
+* [Deployed Contracts](deployed-contracts/deployed-contracts.md)
+
+## Links
+* [Security & Audits](security-and-audits.md)
+* [FAQ]()
+* [Bug Bounty]()