Added title and description metadata

BoilingLime · Dec 27, 2021 · 331b9e2 · 331b9e2
1 parent fc8382d
commit 331b9e2
Show file tree

Hide file tree

Showing 15 changed files with 81 additions and 8 deletions.
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -1,8 +1,13 @@
+---
+title: Rarible Union Protocol API Reference
+description: API references for different blockchain networks working with the protocol
+---
+
 # API Reference
 
 Use these base URLs to access our API on different networks.
 
-`api.rarible.org or any testnet equivalent` is compatible with all blockchains  supported by the Rarible Protocol. We also use the term union to describe this compatibility case in the docs. 
+`api.rarible.org or any testnet equivalent` is compatible with all blockchains supported by the Rarible Protocol. We also use the term union to describe this compatibility case in the docs.
 
 `ethereum-api.rarible.org or any testnet equivalent` is only compatible with the ethereum blockchain.
 

diff --git a/docs/faq.md b/docs/faq.md
@@ -1,3 +1,8 @@
+---
+title: FAQ
+description: Frequently Asked Questions about working with the Rarible Protocol
+---
+
 # Frequently Asked Questions
 
 See [Discussion QA section](https://github.com/rarible/protocol/discussions/categories/q-a) on our GitHub repo, [Discord](https://discord.gg/zqsZsEWBbN), and [documentation](https://docs.rarible.org/) for more answers.

diff --git a/docs/getting-started/community.md b/docs/getting-started/community.md
@@ -1,3 +1,8 @@
+---
+title: Rarible Protocol Community and Resources
+description: Community and resources available to Rarible Protocol users
+---
+
 # Community and resources
 
 ## DAO

diff --git a/docs/getting-started/glossary.md b/docs/getting-started/glossary.md
@@ -1,3 +1,8 @@
+---
+title: Rarible Protocol Glossary
+description: Glossary with an alphabetical list, definitions, and terms related to Rarible Protocol API
+---
+
 # Glossary
 
 This document contains a glossary with an alphabetical list, definitions, and terms related to API.

diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md
@@ -1,3 +1,8 @@
+---
+title: Rarible Protocol Quick Start
+description: Quick Start Guide for starting using Rarible Union Protocol SDK
+---
+
 # Quick Start
 
 It's a Quick Start Guide for starting using Union SDK.

diff --git a/docs/getting-started/reasons.md b/docs/getting-started/reasons.md
@@ -1,3 +1,8 @@
+---
+title: Why build on Rarible protocol?
+description: Reasons to start using Rarible Protocol
+---
+
 # Why build on Rarible protocol?
 
 Rarible pursues the goal of creating a highly liquid environment for all NFTs out there: a robust on-chain protocol designed for NFTs to exist in a connected space. A separate initiative with a dedicated team will enable direct interactions with the protocol from multiple front ends like storefronts or wallets, offering additional distribution channels and enhancing liquidity. It will also fuel the discovery of new NFT trading mechanics.

diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,6 @@
 ---
+title: Rarible Protocol Documentation
+description: Rarible Protocol is a blockchain-agnostic and decentralized tool to query, issue, and trade NFTs
 hide:
 - toc
 - feedback

diff --git a/docs/overview/union.md b/docs/overview/union.md
@@ -1,3 +1,8 @@
+---
+title: Rarible Union Protocol Overview
+description: Rarible Union Protocol is a blockchain-agnostic and decentralized tool to query, issue, and trade NFTs
+---
+
 # Rarible Union Protocol
 
 Rarible Union Protocol is a tool to query, issue and trade NFTs on these blockchains:

diff --git a/docs/union-sdk.md b/docs/union-sdk.md
@@ -1,3 +1,8 @@
+---
+title: Rarible Union Protocol SDK
+description: Rarible Union Protocol SDK enables applications to interact with protocol easily: query, issue, trade NFTs on any blockchain supported
+---
+
 # Union SDK
 
 Rarible Protocol Software Development Kit enables applications to interact with Rarible protocol easily: query, issue, trade NFTs on any blockchain supported.

diff --git a/docs/use-cases/bubblesdk.md b/docs/use-cases/bubblesdk.md
@@ -1,3 +1,8 @@
+---
+title: Rarible SDK No-Code plugin for Bubble
+description: You can now use the Rarible Protocol SDK and build your own NFT Marketplace without deep knowledge on how to code
+---
+
 # Rarible SDK No-Code plugin
 
 This plugin has been developed by [EzCode](https://ezcode.co).

diff --git a/docs/use-cases/coconft.md b/docs/use-cases/coconft.md
@@ -1,10 +1,15 @@
+---
+title: cocoNFT use case with Rarible Smart Contracts
+description: cocoNFT uses lazy minting so that the creators don't have to pay for minting making the process easy for newbies to crypto
+---
+
 # cocoNFT
 
 **TLDR:**
 
 cocoNFT helps new creators get into the NFT space by building an onRamp that makes it easy to manage your wallet via social media logins.
 
-cocoNFT uses the following Smart Contract functionalities:  lazy minting, exchange, and indexer.
+cocoNFT uses the following Smart Contract functionalities: lazy minting, exchange, and indexer.
 
 cocoNFT uses lazy minting so that the creators don't have to pay for minting making the process easy for newbies to crypto. They are planning on using the ability to support checkout right on our website via the Rarible Protocol Exchange and the indexer I believe to show a user's Lazy Minted NFTs.
 
@@ -22,10 +27,12 @@ In regards to the database side cocoNFT advises understanding how you structure
 2. Identify which NFT token type you will be using, 721 or 1155, and make any modifications necessary in the tokens folder: https://github.com/rarible/protocol-contracts/tree/master/tokens
 3. Update the migrations files to pass in whatever parameters you want for the contract you plan to deploy: https://github.com/rarible/protocol-contracts/tree/master/tokens/migrations
 
-**Note:** Only migration files 1-4 are necessary for initial deployment, and only #2 for 721 and #3 for 1155 if you don't want to deploy contracts for both.
+ ???+ note
+
+  Only migration files 1-4 are necessary for initial deployment, and only #2 for 721 and #3 for 1155 if you don't want to deploy contracts for both.
 
-4. Take note of the addresses for the contracts. These are upgradeable contracts, so that you will be directing calls to the proxy address.
-5. Test some functions like `name()` or `symbol()` in your terminal to ensure it's working
-6. Start using Rarible's APIs for lazy minting and order creation to build out your marketplace: https://api-reference.rarible.com/#operation/upsertOrder
+6. Take note of the addresses for the contracts. These are upgradeable contracts, so that you will be directing calls to the proxy address.
+7. Test some functions like `name()` or `symbol()` in your terminal to ensure it's working
+8. Start using Rarible's APIs for lazy minting and order creation to build out your marketplace: https://api-reference.rarible.com/#operation/upsertOrder
 
 API and/or SDK is in the works for cocoNFT.
diff --git a/docs/use-cases/mintgate.md b/docs/use-cases/mintgate.md
@@ -1,4 +1,10 @@
+---
+title: MintGate use case with Rarible Protocol
+description: MintGate integration Rarible Protocol by building their marketplace on it to provide the best experience for the community of creators and influencers
+---
+
 # MintGate
+
 **TLDR:** 
 
 MintGate decided to integrate Rarible protocol by building their marketplace on it to provide the best experience for their growing community of creators and influencers.
@@ -22,8 +28,10 @@ Mintgate hopes Rarible will be able to complete an SDK alternative to the API's
 1. Fork Rarible Protocol: https://github.com/rarible/protocol-contracts (Best to explore and get familiar)
 2. Identify which NFT token type you will be using, 721 or 1155, and make any modifications necessary in the tokens folder: https://github.com/rarible/protocol-contracts/tree/master/tokens
 3. Update the migrations files to pass in whatever parameters you want for the contract you plan to deploy: https://github.com/rarible/protocol-contracts/tree/master/tokens/migrations
-
- **Note:** Only migration files 1-4 are necessary for initial deployment, and only #2 for 721 and #3 for 1155 if you don't want to deploy contracts for both
+
+ ???+ note
+
+  Only migration files 1-4 are necessary for initial deployment, and only #2 for 721 and #3 for 1155 if you don't want to deploy contracts for both.
 
 4. Take note of the addresses for the contracts. These are upgradeable contracts, so you will be directing calls to the proxy address. 
 5. Test some functions like `name()` or `symbol()` in your terminal to ensure it's working

diff --git a/docs/use-cases/picnic.md b/docs/use-cases/picnic.md
@@ -1,3 +1,8 @@
+---
+title: Picnic use case with Rarible Protocol
+description: Using Rarible Protocol to help identify NFTs from creators and collectors in the Picnic showcase
+---
+
 # Picnic
 
 We use Rarible to help us identify NFTs from creators and collectors in the Picnic showcase. The Rarible API provides a few great endpoints for fetching the necessary data.

diff --git a/docs/use-cases/royalties-on-a-external-collection.md b/docs/use-cases/royalties-on-a-external-collection.md
@@ -1,3 +1,8 @@
+---
+title: Setting Up Royalties
+description: Example of setting up royalties on an external Collection
+---
+
 # Setting Up Royalties on an External Collection
 
 1. Open the royalties contract in a new tab: [**https://etherscan.io/address/0xEa90CFad1b8e030B8Fd3E63D22074E0AEb8E0DCD#writeProxyContract**](https://etherscan.io/address/0xEa90CFad1b8e030B8Fd3E63D22074E0AEb8E0DCD#writeProxyContract)

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -129,3 +129,4 @@ markdown_extensions:
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.snippets
+ - meta