From 07330d359256e5140eb3f3bfa66cdbced9500c15 Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Tue, 7 Jun 2022 18:27:16 -0300 Subject: [PATCH 1/8] fix comments Signed-off-by: Evaldo Felipe --- sidebars.js | 5 ----- 1 file changed, 5 deletions(-) diff --git a/sidebars.js b/sidebars.js index c24f91e4..8ca31566 100644 --- a/sidebars.js +++ b/sidebars.js @@ -45,11 +45,6 @@ module.exports = { label: "LongShortPair (LSP)", items: ["synthetic-tokens/long-short-pair", "developers/lsp-prereqs", "developers/deploy-an-lsp"], }, - // { - // type: "category", - // label: "Minting Tokens", - // items: ["developers/mint-locally", "developers/mint-etherscan"], - // }, { type: "category", label: "Bots", From 6fd9c286c0e59adab52143b66c35d0dd332d6bbe Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Fri, 10 Jun 2022 09:47:40 -0300 Subject: [PATCH 2/8] Update soldoc version Signed-off-by: Evaldo Felipe --- ci/solidity-docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/solidity-docs.sh b/ci/solidity-docs.sh index 45055b4b..824b917b 100755 --- a/ci/solidity-docs.sh +++ b/ci/solidity-docs.sh @@ -5,7 +5,7 @@ set -o nounset echo "installing required tools..." yarn install -npm install -g solidity-docgen@0.5.16 +npm install -g solidity-docgen echo "installing protocol repo..." git clone http://github.com/umaprotocol/protocol/ --single-branch || echo "Repo already exists" From 34da7b0aa8ac1ed27a36e165036b2c256819c87b Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Fri, 10 Jun 2022 11:30:07 -0300 Subject: [PATCH 3/8] Update node version Signed-off-by: Evaldo Felipe --- ci/solidity-docs.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ci/solidity-docs.sh b/ci/solidity-docs.sh index 824b917b..7ed0b08f 100755 --- a/ci/solidity-docs.sh +++ b/ci/solidity-docs.sh @@ -5,7 +5,7 @@ set -o nounset echo "installing required tools..." yarn install -npm install -g solidity-docgen +npm install -g solidity-docgen@0.5.16 echo "installing protocol repo..." git clone http://github.com/umaprotocol/protocol/ --single-branch || echo "Repo already exists" @@ -26,3 +26,4 @@ cat << EOF > $contracts_file The sidebar displays an autogenerated list of UMA smart contracts. EOF + From f98bac0f407ec89213947a0370d0c934ae3b3882 Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Fri, 10 Jun 2022 11:35:04 -0300 Subject: [PATCH 4/8] Adjust menu Signed-off-by: Evaldo Felipe --- ci/solidity-docs.sh | 1 - sidebars.js | 93 --------------------------------------------- 2 files changed, 94 deletions(-) diff --git a/ci/solidity-docs.sh b/ci/solidity-docs.sh index 7ed0b08f..45055b4b 100755 --- a/ci/solidity-docs.sh +++ b/ci/solidity-docs.sh @@ -26,4 +26,3 @@ cat << EOF > $contracts_file The sidebar displays an autogenerated list of UMA smart contracts. EOF - diff --git a/sidebars.js b/sidebars.js index 8ca31566..d5529232 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,98 +1,5 @@ module.exports = { - "Oracle": [ - "getting-started/welcome", - { - type: "category", - label: "Developer Quickstart", - items: ["dev-quickstart/deploy-lsp", "dev-quickstart/mint-tokens", "dev-quickstart/price-request", "dev-quickstart/propose-price", "dev-quickstart/settle"], - }, - { - type: "category", - label: "Oracle Service", - items: ["getting-started/oracle", "oracle/econ-architecture", "oracle/tech-architecture", "oracle/known-issues"], - }, - "dev-ref/bug-bounty", - "synthetic-tokens/glossary" - ], - "DAO Products": [ - "products/dao-products", - { - type: "category", - label: "KPI Options", - items: ["kpi-options/summary", "kpi-options/deployment-tutorial","kpi-options/kpi-price-identifier", "kpi-options/usage-tutorial","kpi-options/references"], - }, - { - type: "category", - label: "Success Tokens", - items: ["success-tokens/summary", "success-tokens/deployment-tutorial", "success-tokens/usage-tutorial", "success-tokens/references"], - }, - { - type: "category", - label: "Range Tokens", - items: ["range-tokens/summary", "range-tokens/deployment-tutorial", "range-tokens/usage-tutorial", "range-tokens/references"], - }, - { - type: "category", - label: "Other Products", - items: ["products/calloption", "products/protected-tokens"], - }, - ], - Developers: [ - "build-walkthrough/build-process", - { - type: "category", - label: "LongShortPair (LSP)", - items: ["synthetic-tokens/long-short-pair", "developers/lsp-prereqs", "developers/deploy-an-lsp"], - }, - { - type: "category", - label: "Bots", - items: ["developers/setup","developers/bots", "developers/bot-param", "developers/pf-configuration"], - }, - { - type: "category", - label: "Advanced Tutorials", - items: ["developers/optimistic-oracle-integration", "developers/dvm-integration"], - }, - { - type: "category", - label: "Developer Reference", - items: ["dev-ref/mainnet-info", "dev-ref/addresses", "dev-ref/subgraphs", "getting-started/scalingsolutions", "oracle/dvm-interface", "oracle/optimistic-oracle-interface", - { - type: "link", - label: "Contracts (Github)", - href: - "https://github.com/UMAprotocol/protocol/tree/master/packages/core/contracts", - }, - { - type: "link", - label: "Contract Documentation", - href: - "https://docs-git-doc-updates-uma.vercel.app/contracts/Contracts", - },], - }, - - ], - "UMA Tokenholders": [ - "uma-tokenholders/uma-holders", - "uma-tokenholders/uma-tokenomics", - { - type: "category", - label: "Price IDs and Collateral Currencies", - items: ["uma-tokenholders/adding-price-id", "uma-tokenholders/approved-price-identifiers", "uma-tokenholders/approved-collateral-currencies","uma-tokenholders/guidance-on-adding-price-identifiers","uma-tokenholders/guidence-on-collateral-currency-addition",], - }, - "uma-tokenholders/umips", - "uma-tokenholders/voter-dApp", - ], - "Community": [ - "community/community-overview", "community/superUMAns", - { - type: "category", - label: "Events & Press", - items: ["community/press", "community/blog-posts", "community/events"], - }, - ], "Contracts": [ { type: "autogenerated", From 814887c4a326fd3ebe0a12d285782c0e9b9c62fa Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Fri, 10 Jun 2022 11:48:45 -0300 Subject: [PATCH 5/8] Update doc menu Signed-off-by: Evaldo Felipe --- config/footer.js | 50 ++++++++++++------------ config/navbar.js | 56 +++++++++++++------------- docusaurus.config.js | 4 +- sidebars.js | 93 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 148 insertions(+), 55 deletions(-) diff --git a/config/footer.js b/config/footer.js index 939e5c50..ea9298c8 100644 --- a/config/footer.js +++ b/config/footer.js @@ -1,30 +1,30 @@ module.exports = { links: [ - { - title: "Docs", - items: [ - { - label: "Oracle", - to: "/", - }, - { - label: "DAO Products", - to: "/products/dao-products", - }, - { - label: "Developers", - to: "developers/setup", - }, - { - label: "Tokenholders", - to: "uma-tokenholders/uma-holders", - }, - { - label: "Community", - to: "community/community-overview", - }, - ], - }, + // { + // title: "Docs", + // items: [ + // { + // label: "Oracle", + // to: "/", + // }, + // { + // label: "DAO Products", + // to: "/products/dao-products", + // }, + // { + // label: "Developers", + // to: "developers/setup", + // }, + // { + // label: "Tokenholders", + // to: "uma-tokenholders/uma-holders", + // }, + // { + // label: "Community", + // to: "community/community-overview", + // }, + // ], + // }, { title: "Community", items: [ diff --git a/config/navbar.js b/config/navbar.js index c0e3d2f2..620d7c69 100644 --- a/config/navbar.js +++ b/config/navbar.js @@ -5,18 +5,18 @@ module.exports = { src: "img/UMA_square_red_logo.png", }, items: [ - { - to: "/", - label: "Oracle", - position: "left", - activeBaseRegex: "(/$|econ-architecture|dev-quickstart|bug-bounty|oracle/tech-architecture|oracle/known-issues|getting-started/oracle|getting-started/oracle|synthetic-tokens/glossary)", - }, - { - to: "products/dao-products", - label: "DAO Products", - position: "left", - activeBaseRegex: "(products|range-tokens|success-tokens|kpi-options|synthetic-tokens/what-are-synthetic-assets|synthetic-tokens/expiring-synthetic-tokens|synthetic-tokens/known-issues)", - }, + // { + // to: "/", + // label: "Oracle", + // position: "left", + // activeBaseRegex: "(/$|econ-architecture|dev-quickstart|bug-bounty|oracle/tech-architecture|oracle/known-issues|getting-started/oracle|getting-started/oracle|synthetic-tokens/glossary)", + // }, + // { + // to: "products/dao-products", + // label: "DAO Products", + // position: "left", + // activeBaseRegex: "(products|range-tokens|success-tokens|kpi-options|synthetic-tokens/what-are-synthetic-assets|synthetic-tokens/expiring-synthetic-tokens|synthetic-tokens/known-issues)", + // }, // { // label: "Understanding UMA", // to: "synthetic-tokens/explainer", @@ -35,28 +35,28 @@ module.exports = { // // }, // // ], // }, - { - to: "build-walkthrough/build-process", - label: "Developers", - position: "left", - activeBaseRegex: "(developers|build-walkthrough|getting-started/scalingsolutions|oracle/dvm-interface|oracle/optimistic-oracle-interface|synthetic-tokens/long-short-pair|dev-ref/mainnet-info|dev-ref/addresses|dev-ref/subgraphs)", - }, - { - to: "uma-tokenholders/uma-holders", - label: "Tokenholders", - position: "left", - activeBasePath: "uma-tokenholders", - }, + // { + // to: "build-walkthrough/build-process", + // label: "Developers", + // position: "left", + // activeBaseRegex: "(developers|build-walkthrough|getting-started/scalingsolutions|oracle/dvm-interface|oracle/optimistic-oracle-interface|synthetic-tokens/long-short-pair|dev-ref/mainnet-info|dev-ref/addresses|dev-ref/subgraphs)", + // }, + // { + // to: "uma-tokenholders/uma-holders", + // label: "Tokenholders", + // position: "left", + // activeBasePath: "uma-tokenholders", + // }, // { // to: "dev-ref/addresses", // label: "Developer Reference", // position: "left", // activeBasePath: "dev-ref", // }, - { to: "community/community-overview", - label: "Community", - position: "left", - activeBaseRegex: "(users|community)" }, + // { to: "community/community-overview", + // label: "Community", + // position: "left", + // activeBaseRegex: "(users|community)" }, { to: "contracts/Contracts", label: "Contracts", position: "left", diff --git a/docusaurus.config.js b/docusaurus.config.js index d1679433..7156e1e4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -6,10 +6,10 @@ module.exports = { title: "UMA Docs", tagline: "A protocol for building synthetic assets", url: "https://docs.umaproject.org/", - baseUrl: "/", + baseUrl: "/contracts/Contracts", favicon: "img/favicon-32x32.png", organizationName: "umaprotocol", - projectName: "docs", + projectName: "contracts docs", themeConfig: { navbar, footer, diff --git a/sidebars.js b/sidebars.js index d5529232..39ddaaf1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1,5 +1,98 @@ module.exports = { + // "Oracle": [ + // "getting-started/welcome", + // { + // type: "category", + // label: "Developer Quickstart", + // items: ["dev-quickstart/deploy-lsp", "dev-quickstart/mint-tokens", "dev-quickstart/price-request", "dev-quickstart/propose-price", "dev-quickstart/settle"], + // }, + // { + // type: "category", + // label: "Oracle Service", + // items: ["getting-started/oracle", "oracle/econ-architecture", "oracle/tech-architecture", "oracle/known-issues"], + // }, + // "dev-ref/bug-bounty", + // "synthetic-tokens/glossary" + // ], + // "DAO Products": [ + // "products/dao-products", + // { + // type: "category", + // label: "KPI Options", + // items: ["kpi-options/summary", "kpi-options/deployment-tutorial","kpi-options/kpi-price-identifier", "kpi-options/usage-tutorial","kpi-options/references"], + // }, + // { + // type: "category", + // label: "Success Tokens", + // items: ["success-tokens/summary", "success-tokens/deployment-tutorial", "success-tokens/usage-tutorial", "success-tokens/references"], + // }, + // { + // type: "category", + // label: "Range Tokens", + // items: ["range-tokens/summary", "range-tokens/deployment-tutorial", "range-tokens/usage-tutorial", "range-tokens/references"], + // }, + // { + // type: "category", + // label: "Other Products", + // items: ["products/calloption", "products/protected-tokens"], + // }, + // ], + // Developers: [ + // "build-walkthrough/build-process", + // { + // type: "category", + // label: "LongShortPair (LSP)", + // items: ["synthetic-tokens/long-short-pair", "developers/lsp-prereqs", "developers/deploy-an-lsp"], + // }, + // { + // type: "category", + // label: "Bots", + // items: ["developers/setup","developers/bots", "developers/bot-param", "developers/pf-configuration"], + // }, + // { + // type: "category", + // label: "Advanced Tutorials", + // items: ["developers/optimistic-oracle-integration", "developers/dvm-integration"], + // }, + // { + // type: "category", + // label: "Developer Reference", + // items: ["dev-ref/mainnet-info", "dev-ref/addresses", "dev-ref/subgraphs", "getting-started/scalingsolutions", "oracle/dvm-interface", "oracle/optimistic-oracle-interface", + // { + // type: "link", + // label: "Contracts (Github)", + // href: + // "https://github.com/UMAprotocol/protocol/tree/master/packages/core/contracts", + // }, + // { + // type: "link", + // label: "Contract Documentation", + // href: + // "https://docs-git-doc-updates-uma.vercel.app/contracts/Contracts", + // },], + // }, + + // ], + // "UMA Tokenholders": [ + // "uma-tokenholders/uma-holders", + // "uma-tokenholders/uma-tokenomics", + // { + // type: "category", + // label: "Price IDs and Collateral Currencies", + // items: ["uma-tokenholders/adding-price-id", "uma-tokenholders/approved-price-identifiers", "uma-tokenholders/approved-collateral-currencies","uma-tokenholders/guidance-on-adding-price-identifiers","uma-tokenholders/guidence-on-collateral-currency-addition",], + // }, + // "uma-tokenholders/umips", + // "uma-tokenholders/voter-dApp", + // ], + // "Community": [ + // "community/community-overview", "community/superUMAns", + // { + // type: "category", + // label: "Events & Press", + // items: ["community/press", "community/blog-posts", "community/events"], + // }, + // ], "Contracts": [ { type: "autogenerated", From bf203930300921445464eeac1c6a097f5cbced16 Mon Sep 17 00:00:00 2001 From: Evaldo Felipe Date: Fri, 10 Jun 2022 12:43:34 -0300 Subject: [PATCH 6/8] Update docs Signed-off-by: Evaldo Felipe --- ci/solidity-docs.sh | 2 +- config/navbar.js | 2 +- config/redirects.js | 267 ++++++++++++++++---------------- docs/getting-started/welcome.md | 41 +---- docusaurus.config.js | 10 +- 5 files changed, 142 insertions(+), 180 deletions(-) diff --git a/ci/solidity-docs.sh b/ci/solidity-docs.sh index 45055b4b..13260d1e 100755 --- a/ci/solidity-docs.sh +++ b/ci/solidity-docs.sh @@ -8,7 +8,7 @@ yarn install npm install -g solidity-docgen@0.5.16 echo "installing protocol repo..." -git clone http://github.com/umaprotocol/protocol/ --single-branch || echo "Repo already exists" +git clone https://github.com/umaprotocol/protocol/ --single-branch || echo "Repo already exists" yarn install --cwd protocol/packages/core --ignore-scripts echo "generating docs files..." diff --git a/config/navbar.js b/config/navbar.js index 620d7c69..91e36a81 100644 --- a/config/navbar.js +++ b/config/navbar.js @@ -1,5 +1,5 @@ module.exports = { - title: "Docs", + title: "Contracts Docs", logo: { alt: "UMA Logo", src: "img/UMA_square_red_logo.png", diff --git a/config/redirects.js b/config/redirects.js index c6ef76e7..c84f4848 100644 --- a/config/redirects.js +++ b/config/redirects.js @@ -1,139 +1,140 @@ module.exports = [ - { - to: "/", - from: ["/uma/index.html", "/uma/community/connecting_with_UMA.html"], - }, - // getting started - { - to: "/getting-started/oracle", - from: ["/uma/getting_started/uma_oracle_design.html"], - }, + + // { + // to: "/", + // from: ["/uma/index.html", "/uma/community/connecting_with_UMA.html"], + // }, + // // getting started + // { + // to: "/getting-started/oracle", + // from: ["/uma/getting_started/uma_oracle_design.html"], + // }, - // synthetic tokens + // // synthetic tokens - { - to: "/synthetic-tokens/expiring-synthetic-tokens", - from: ["/uma/synthetic-tokens/expiring-synthetic-tokens.html"], - }, - { - to: "/synthetic-tokens/glossary", - from: ["/uma/synthetic_tokens/glossary.html"], - }, - { - to: "/synthetic-tokens/known-issues", - from: ["/uma/synthetic_tokens/known_issues.html"], - }, - { - to: "/synthetic-tokens/long-short-pair", - from: ["/uma/synthetic_tokens/long-short-pair.html"], - }, - // featured products - { - to: "/products/KPI-options", - from: ["/uma/products/KPI-options.html"], - }, - { - to: "/products/range-tokens", - from: ["/uma/products/range-tokens.html"], - }, - { - to: "/products/calloption", - from: ["/uma/products/calloption.html"], - }, - // developers (synthetic tokens) - { - to: "/developers/setup", - from: ["/uma/synthetic_tokens/prerequisites.html"], - }, - { - to: "/build-walkthrough/mint-locally", - from: ["/uma/synthetic_tokens/creating_from_truffle.html"], - }, - { - to: "/developers/bots", - from: ["/uma/synthetic_tokens/liquidation.html"], - }, - { - to: "/developers/bot-param", - from: ["/uma/synthetic_tokens/bot_parameterization.html"], - }, - { - to: "/build-walkthrough/minting-etherscan", - from: ["/uma/synthetic_tokens/mint_tokens_via_etherscan.html"], - }, - // oracle - { - to: "/oracle/tech-architecture", - from: ["/uma/oracle/technical_architecture.html"], - }, - { - to: "/oracle/econ-architecture", - from: ["/uma/oracle/economic_architecture.html"], - }, - { - to: "/oracle/dvm-interface", - from: ["/uma/oracle/dvm_interfaces.html"], - }, - { - to: "/oracle/optimistic-oracle-interface", - from: ["/uma/oracle/optimistic-oracle-interface.html"], - }, - { - to: "/oracle/known-issues", - from: ["/uma/oracle/known_issues.html"], - }, - // developers (oracle) - { - to: "/developers/dvm-integration", - from: ["/uma/oracle/integrating_the_dvm.html"], - }, - // UMA Tokenholders - { - to: "/uma-tokenholders/uma-holders", - from: ["/uma/oracle/UMA_token_holder_responsibilities.html"], - }, - { - to: "/uma-tokenholders/umips", - from: ["/uma/oracle/UMIPs.html"], - }, - { - to: "/uma-tokenholders/adding-price-id", - from: ["/uma/oracle/adding_a_price_identifier.html"], + // { + // to: "/synthetic-tokens/expiring-synthetic-tokens", + // from: ["/uma/synthetic-tokens/expiring-synthetic-tokens.html"], + // }, + // { + // to: "/synthetic-tokens/glossary", + // from: ["/uma/synthetic_tokens/glossary.html"], + // }, + // { + // to: "/synthetic-tokens/known-issues", + // from: ["/uma/synthetic_tokens/known_issues.html"], + // }, + // { + // to: "/synthetic-tokens/long-short-pair", + // from: ["/uma/synthetic_tokens/long-short-pair.html"], + // }, + // // featured products + // { + // to: "/products/KPI-options", + // from: ["/uma/products/KPI-options.html"], + // }, + // { + // to: "/products/range-tokens", + // from: ["/uma/products/range-tokens.html"], + // }, + // { + // to: "/products/calloption", + // from: ["/uma/products/calloption.html"], + // }, + // // developers (synthetic tokens) + // { + // to: "/developers/setup", + // from: ["/uma/synthetic_tokens/prerequisites.html"], + // }, + // { + // to: "/build-walkthrough/mint-locally", + // from: ["/uma/synthetic_tokens/creating_from_truffle.html"], + // }, + // { + // to: "/developers/bots", + // from: ["/uma/synthetic_tokens/liquidation.html"], + // }, + // { + // to: "/developers/bot-param", + // from: ["/uma/synthetic_tokens/bot_parameterization.html"], + // }, + // { + // to: "/build-walkthrough/minting-etherscan", + // from: ["/uma/synthetic_tokens/mint_tokens_via_etherscan.html"], + // }, + // // oracle + // { + // to: "/oracle/tech-architecture", + // from: ["/uma/oracle/technical_architecture.html"], + // }, + // { + // to: "/oracle/econ-architecture", + // from: ["/uma/oracle/economic_architecture.html"], + // }, + // { + // to: "/oracle/dvm-interface", + // from: ["/uma/oracle/dvm_interfaces.html"], + // }, + // { + // to: "/oracle/optimistic-oracle-interface", + // from: ["/uma/oracle/optimistic-oracle-interface.html"], + // }, + // { + // to: "/oracle/known-issues", + // from: ["/uma/oracle/known_issues.html"], + // }, + // // developers (oracle) + // { + // to: "/developers/dvm-integration", + // from: ["/uma/oracle/integrating_the_dvm.html"], + // }, + // // UMA Tokenholders + // { + // to: "/uma-tokenholders/uma-holders", + // from: ["/uma/oracle/UMA_token_holder_responsibilities.html"], + // }, + // { + // to: "/uma-tokenholders/umips", + // from: ["/uma/oracle/UMIPs.html"], + // }, + // { + // to: "/uma-tokenholders/adding-price-id", + // from: ["/uma/oracle/adding_a_price_identifier.html"], - }, + // }, - { - to: "/uma-tokenholders/voting-2key", - from: ["/uma/oracle/voting_with_UMA_2-key_contract.html"], - }, - // developer reference - { - to: "/dev-ref/addresses", - from: ["/uma/developer_reference/contract_addresses.html"], - }, - { - to: "/dev-ref/bug-bounty", - from: ["/uma/developer_reference/bug_bounty.html"], - }, - { - to: "/dev-ref/subgraphs", - from: ["/uma/developer_reference/subgraphs.html"], - }, - { - to: "/dev-ref/mainnet-info", - from: ["/uma/developer_reference/mainnet_deployment_info.html"], - }, - // community - { - to: "/community/events", - from: ["/uma/community/previous_and_upcoming_events.html"], - }, - { - to: "/community/press", - from: ["/uma/community/interviews_and_press.html"], - }, - { - to: "/community/blog-posts", - from: ["/uma/community/blog_posts.html"], - }, + // { + // to: "/uma-tokenholders/voting-2key", + // from: ["/uma/oracle/voting_with_UMA_2-key_contract.html"], + // }, + // // developer reference + // { + // to: "/dev-ref/addresses", + // from: ["/uma/developer_reference/contract_addresses.html"], + // }, + // { + // to: "/dev-ref/bug-bounty", + // from: ["/uma/developer_reference/bug_bounty.html"], + // }, + // { + // to: "/dev-ref/subgraphs", + // from: ["/uma/developer_reference/subgraphs.html"], + // }, + // { + // to: "/dev-ref/mainnet-info", + // from: ["/uma/developer_reference/mainnet_deployment_info.html"], + // }, + // // community + // { + // to: "/community/events", + // from: ["/uma/community/previous_and_upcoming_events.html"], + // }, + // { + // to: "/community/press", + // from: ["/uma/community/interviews_and_press.html"], + // }, + // { + // to: "/community/blog-posts", + // from: ["/uma/community/blog_posts.html"], + // }, ]; diff --git a/docs/getting-started/welcome.md b/docs/getting-started/welcome.md index 20d6f2ad..d6784164 100644 --- a/docs/getting-started/welcome.md +++ b/docs/getting-started/welcome.md @@ -1,44 +1,5 @@ --- -title: Welcome to UMA +title: Smart contracts documentation sidebar_label: Welcome to UMA slug: / --- -UMA is an optimistic oracle that uses economic guarantees to secure markets. Unlike mechanically restrictive price feed oracles, an optimistic oracle is able to serve any arbitrary data on-chain. UMA’s flexible oracle serves data for uses including a cross-chain bridge, insurance, custom derivatives and prediction markets among other things. - -The UMA Protocol also provides various smart contract templates that are automatically secured by its optimistic oracle. Among these are contract templates and integrations for creating synthetic tokens, predictions markets, "KPI options" and structured financial products. - -## Integration Partners - -Integration | Website | Description -------------- | ------------- | ------------- - | [Across](https://across.to/) | Across protocol is a novel bridging method that combines UMA's Optimistic Oracle with bonded relayers and single-sided liquidity pools to provide decentralized instant transactions from rollup chains to Ethereum mainnet. - | [Polymarket](https://polymarket.com/) | Polymarket is an information markets platform that lets you trade on the world’s most highly-debated topics. Polymarket supports UMA and its Optimistic Oracle as a resolution source for its markets. - | [Jarvis Network](https://jarvis.network/) | Jarvis Network is a set of protocols on Ethereum allowing anyone to gain exposure to the price of any traditional or digital assets with stablecoins, against liquidity pools. Jarvis leverages UMA's Optimistic Oracle and DVM as its liquidation and dispute mechanism to ensure that jFIATs are properly collateralized. - | [Sherlock](https://www.sherlock.xyz/) | Sherlock is a protocol on the Ethereum blockchain that protects users from smart contract exploits with proprietary security analysis and protocol-level coverage. UMA acts as an unbiased, decentralized arbiter for Sherlock where disputes are escalated to UMA's DVM and voted on to be resolved. - | [Domination Finance](https://domination.finance/) | Domination Finance is a decentralized exchange (DEX) deployed on Ethereum and Polygon. Domination Finance uses UMA's Optimistic Oracle to enable users to speculate on popular market dominance metrics, such as Bitcoin Dominance (BTCDOM). - | [Yam Synths](https://synths.yam.xyz/) | Yam Synths is a powerful platform from the Yam DAO community providing easily accessible and innovative synthetic assets. UMA's Optimistic Oracle helps Yam to allow anyone in the world to access and trade cutting-edge synthetic products. - | [Hats.finance](https://hats.finance/) | Hats.finance is a proactive bounty protocol for white hat hackers and auditors, where projects, community members, and stakeholders incentivize protocol security and responsible disclosure. Hat.Finance and UMA have collaborated on a product called protected tokens which enable users to recover funds in the event of a hack, bug, or other cause of lost funds. - -## Developers - -If you are a developer interested in building on the UMA Protocol, please refer to these tutorials and resources to get started. -- [Launching a KPI Option](kpi-options/summary) -- [Launching a Success Token](success-tokens/summary) -- [Integrating with the Optimistic Oracle](developers/optimistic-oracle-integration) -- [Proposing an UMA Improvement Proposal (UMIP)](uma-tokenholders/adding-price-id) -- [Understanding the Long Short Pair contract](synthetic-tokens/long-short-pair) -- [Understanding the Optimistic Oracle interface](oracle/optimistic-oracle-interface) - -You can find additional reference materials, including a list of UMA's testnet and mainnet contracts [here](dev-ref/addresses.md). - -## UMA Tokenholders - -Refer [here](uma-tokenholders/uma-holders.md) to learn more about the UMA governance token. - -## UMA Community - -If you have questions or want to connect with the UMA community, check out our [community page](community/community-overview). - -## Contact - -Join our [Discord](https://discord.com/invite/jsb9XQJ) or get involved in conversations on UMA's [Discourse](https://discourse.umaproject.org). \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 7156e1e4..331630f8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -3,13 +3,13 @@ const footer = require("./config/footer"); const redirects = require("./config/redirects"); module.exports = { - title: "UMA Docs", - tagline: "A protocol for building synthetic assets", - url: "https://docs.umaproject.org/", - baseUrl: "/contracts/Contracts", + title: "UMA Contracts Docs", + tagline: "Documentation for smart contracts", + url: "https://contracts.docs.umaproject.org/", + baseUrl: "/", favicon: "img/favicon-32x32.png", organizationName: "umaprotocol", - projectName: "contracts docs", + projectName: "docs", themeConfig: { navbar, footer, From 8adce298c31a0533aa3c3d01010ed54dcb53b3ec Mon Sep 17 00:00:00 2001 From: smb2796 Date: Mon, 13 Jun 2022 11:25:46 -0400 Subject: [PATCH 7/8] fix structure --- config/navbar.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/navbar.js b/config/navbar.js index 91e36a81..21a6707d 100644 --- a/config/navbar.js +++ b/config/navbar.js @@ -57,7 +57,7 @@ module.exports = { // label: "Community", // position: "left", // activeBaseRegex: "(users|community)" }, - { to: "contracts/Contracts", + { to: "/", label: "Contracts", position: "left", activeBaseRegex: "(Contracts)" }, From 5f540872e1df69900693951ae7132e9dc56d62fd Mon Sep 17 00:00:00 2001 From: smb2796 Date: Mon, 13 Jun 2022 11:41:48 -0400 Subject: [PATCH 8/8] revert --- config/navbar.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/navbar.js b/config/navbar.js index 21a6707d..91e36a81 100644 --- a/config/navbar.js +++ b/config/navbar.js @@ -57,7 +57,7 @@ module.exports = { // label: "Community", // position: "left", // activeBaseRegex: "(users|community)" }, - { to: "/", + { to: "contracts/Contracts", label: "Contracts", position: "left", activeBaseRegex: "(Contracts)" },