Skip to content

Commit

Permalink
Add description and keyword metadata for SEO
Browse files Browse the repository at this point in the history
  • Loading branch information
taycaldwell committed Nov 21, 2023
1 parent ea4aca0 commit 76212b8
Show file tree
Hide file tree
Showing 49 changed files with 89 additions and 1 deletion.
2 changes: 2 additions & 0 deletions apps/base-docs/docs/arbitration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Arbitration
slug: /arbitration
description: Arbitration agreement terms for users of Coinbase's services.
keywords: [Base, Coinbase, arbitration agreement, dispute resolution, jury trial waiver, class action waiver, American Arbitration Association, legal claims, cryptocurrency services, consumer arbitration rules, individual arbitration]
---

# APPENDIX 1: BRIDGE INTERFACE, SEQUENCER, AND TESTNET TERMS ARBITRATION AGREEMENT
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/building-with-base/base-contracts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Base Contracts
slug: /base-contracts
description: A comprehensive list of L2 contract addresses for Base Mainnet and Base Testnet, including links to their respective blockchain explorers.
keywords: [Base, Base network, contracts, Base contracts, L2 contract addresses, Base contract addresses, smart contracts, Base smart contracts, Base Mainnet, Base Testnet]
---

# Contract Addresses
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/building-with-base/differences.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Differences between Ethereum and Base
slug: /differences
description: Documentation covering the differences between Ethereum and Base. This page includes details on differences between opcodes, blocks, network specifications, and transaction costs.
keywords: [Ethereum vs Base, Base differences, difference between Base and Ethereum, Bedrock, OP Stack, Base opcodes, Base blocks, opcodes on Base, blocks on Base, Base network specifications, network specifications, Base transaction costs, transaction costs]
---

# Differences between Ethereum and Base
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/building-with-base/fees.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Fees
slug: /fees
description: Documentation about network fees on Base. This page covers details of the two-component cost system involving L2 execution fees and L1 security fees, and offers insights on fee variations and cost-saving strategies.
keywords: [Base fees, transaction fees, network fees, Base network fees, L2 execution fee, L1 security fee, transaction costs, gas fees, fee calculation, cost-saving, transaction timing, fee variations, Base platform]
---

# Fees
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Using thirdweb
slug: /guides/build-with-thirdweb
description: A guide on building an NFT gallery app using thirdweb, including steps for creating an NFT collection, minting NFTs, and configuring the app for the Base testnet.
keywords: [thirdweb, onchain app, dapp, NFT, NFT collection, smart contract, Base blockchain, Base network, Base testnet, Base test network, mint NFTs, web3 wallet, app development, dapp development, build a dapp on Base, build on Base]
---

# Building an App using thirdweb
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Using Hardhat
slug: /guides/deploy-smart-contracts
description: A guide on deploying a smart contract on the Base test network using Hardhat. Includes instructions for
setting up the environment, compiling, and deploying the smart contract.
keywords: [Hardhat, smart contract, ERC-721, Base, Base test network, Base testnet, Node.js, Solidity, smart contract deployment,
deploy a smart contract, build on base, write smart contract, smart contract development]
---

import Tabs from '@theme/Tabs';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Using Remix
slug: /guides/deploy-with-remix
description: A guide on deploying a smart contract on the Base test network using Remix IDE. Includes instructions for
setting up the environment, compiling, and deploying the smart contract.
keywords: [Remix, Remix IDE, smart contract, Base, Base test network, Base testnet, Node.js, Solidity, smart contract deployment,
deploy a smart contract, build on base, write smart contract, smart contract development, online IDE]
---

# Deploying a Smart Contract using Remix
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Using Tenderly
slug: /guides/deploy-with-tenderly
description: A guide on deploying smart contracts using Tenderly DevNets. This page covers setup, debugging, transaction simulations, and continuous integration for smart contract development on Base Network.
keywords: [Tenderly, smart contract, Tenderly DevNets, Base, Base Network, deployment, debugging, transaction simulations, continuous integration, DevNet environment, YAML templates, Hardhat integration, deploy a smart contract, debug a smart contract, smart contract on Base, build on Base]
---

# Deploying a Smart Contract using Tenderly
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Using thirdweb
slug: /guides/deploy-with-thirdweb
description: A guide on deploying and interacting with smart contracts using the thirdweb CLI and SDK. Includes instructions for project creation, contract deployment on the Base test network.
keywords: [thirdweb, thirdweb CLI, thirdweb SDK, Base, Base network, smart contracts, deployment, Base testnet, CLI, Solidity, ERC721, web3 development, SDKs, React, deploy a smart contract, debug a smart contract, smart contract on Base, build on Base]
---

# Deploying a Smart Contract using thirdweb
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Running a Base Node
slug: /guides/run-a-base-node
description: A guide for setting up and running a Base Node.
keywords: [Base Node setup, running a node, base node, run a Base noed, hardware requirements, node synchronization, node snapshots, Base chain, Base blockchain, Base network, node deployment, Ethereum node]
---

This guide will walk you through setting up your own [Base Node].
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/building-with-base/network-information.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Network Information
slug: /network-information
description: Documentation about Base Mainnet and Base Testnet. This page covers network information for the Base network, including network names, descriptions, RPC endpoints, chain IDs, currency symbols, and block explorers.
keywords: [Base network, Base Mainnet, Base Testnet, Goerli, Sepolia, Base Goerli, Base Sepolia, RPC URL, Base RPC URL, Base RPC, Chain ID, chainid, Base Chain ID, Base chainId, network information, Base network information]
---

# Network Information
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Blockchain Providers
description: Learn what providers are and why you need one.
keywords: [blockchain development, dApps, smart contracts, providers, public providers, wallet providers, vendor providers, rate limits, blockchain API, Ethereum provider, Base, Base network, Base node providers, Base providers]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview of Providers
description: Learn what providers are and why you need one.
keywords: [blockchain providers, dApp development, smart contracts, public providers, wallet providers, vendor providers, rate limits, Ethereum, blockchain connection services, provider pricing, Wagmi, Base, Base network, Base node providers, Base providers]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Connecting with a Provider
description: Configure several providers and use them to connect to the blockchain.
keywords: [Rainbowkit, Wagmi, blockchain providers, QuickNode, Alchemy, API keys, blockchain connection, public provider, smart contract development, Base, Base network, Base node providers, Base providers]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview
description: What's in this learning material.
keywords: [blockchain providers, JSON RPC, Rainbowkit, Wagmi, Viem, frontend, smart contract development, EVM, Next.js, Base, Base network, Base node providers, Base providers]
hide_table_of_contents: false
---

Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/contracts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Contracts
slug: /contracts
description: A list of contract addresses for various onchain apps, focusing on both the Base Mainnet and Base Testnet deployments.
keywords: [onchain apps, contract addresses, Base Mainnet, Uniswap v3, Multicall3, Goerli Testnet, blockchain contracts, decentralization, cryptocurrency, smart contracts]
---

# Contracts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Debugging with Hardhat
description: Debugging smart contracts with Hardhat.
keywords: [Hardhat, smart contract debugging, debugging logs, common errors, console.log, error resolution, decentralized applications]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 'Smart Contract Profiling: Gas'
description: Optimize Smart Contract Gas Usage with Hardhat
keywords: [Hardhat, gas optimization, gas usage, gas profiling, Hardhat Gas Reporter plugin, smart contract development, cost savings, contract optimization, gas-efficient contracts]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Improving Gas Usage
description: Reduce the amount of gas used by your smart contracts.
keywords: [smart contracts, gas optimization, gas usage reduction, contract efficiency, cost-effective contracts, Base blockchain, Base network, gas costs, optimization strategies]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Installing the Gas Analyzer
description: Install the Hardhat Gas Analyzer plugin.
keywords: [Hardhat Gas Analyzer, gas profiling, smart contract optimization, gas usage, installation guide, Base blockchain, Base network, blockchain development, gas costs]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Contract Sizer Setup
description: Install the Contract Sizer Plugin
keywords: [Contract Sizer Plugin, smart contract optimization, contract size analysis, installation guide, Base blockchain, Base network, blockchain development]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: 'Smart Contract Profiling: Size'
description: Optimize Smart Contract Sizes with Hardhat
keywords: [Smart Contract Sizes, Hardhat Contract Sizer, Base network, Base blockchain, Blockchain, Contract Optimization, Inheritance, External Contracts, Solidity Optimizer, Smart Contract Development]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Manual Optimizations
description: Adjust your code to make your contracts smaller.
keywords: [Smart Contract Optimization, Base network, Base Blockchain, Blockchain development, Contract Size Reduction, Code Efficiency, Smart Contract Size, Solidity, Manual Optimization]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Using the Optimizer
description: Make your contract more efficient at the cost of making it bigger.
keywords: [Solidity Optimizer, Smart Contract Optimization, Base network, Base blockchain, Contract Efficiency, Solidity, Contract Size, Code Optimization]
hide_table_of_contents: false
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Smart Contract Test Coverage
description: Profiling test coverage with Hardhat and Solidity Coverage
keywords: [Solidity Coverage, Smart Contract Testing, Test Coverage, Base network, Base blockchain, blockchain development, Hardhat, Solidity, Code Testing, Test Suite Analysis]
hide_table_of_contents: false
---

Expand Down
1 change: 1 addition & 0 deletions apps/base-docs/docs/hardhat-tools-and-testing/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Overview
description: What's in this learning material.
keywords: [Hardhat Tools, Smart Contract Development, Gas Optimization, Debugging, Test Coverage, Contract Size, Solidity, Base network, Base blockchain, blockchain development]
hide_table_of_contents: false
---

Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: About Base
slug: /
description: An overview of Base, an Ethereum L2 platform incubated by Coinbase, focusing on its secure, low-cost, and builder-friendly features, along with its commitment to decentralization and accessibility for the global cryptoeconomy.
eywords: [Base, Ethereum L2, Coinbase, decentralization, cryptoeconomy, EVM, blockchain, OP Stack, Optimism, decentralized apps]
---

# About Base
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/privacy-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Privacy Policy
slug: /privacy-policy
description: The Privacy Policy for Base. Covers how we collect, use, and share personal information of users and developers through our services, including legal bases and data retention.
keywords: [Base, Base Privacy Policy, personal information, data collection, user privacy, developer data, service providers, data sharing, legal compliance, data protection, international data transfers]
---

# Base Global Privacy Policy
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/security.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Security
slug: /security
description: The Base bug bounty program and procedures for reporting vulnerabilities.
keywords: [Base, Coinbase, bug bounty program, report vulnerability, bug report, cybersecurity, HackerOne, Base network, Bedrock, Optimism, vulnerability reporting, crypto security, open source]
---

# Security
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/terms-of-service.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Terms of Service
slug: /terms-of-service
description: The Terms of Service for using Coinbase's "Base," a layer-two optimistic rollup on Ethereum.
keywords: [Base, Coinbase, terms and conditions, terms of service, warranty disclaimers, liability limitations, service terms]
---

# Bridge Interface, Sequencer, and Testnet Terms
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tokens.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Tokens
slug: /tokens/list
description: How to submit ERC-20 tokens for bridging between Ethereum and Base as a token issuer.
keywords: [Base Token List, ERC-20 tokens, Ethereum, Base Mainnet, Base Bridge, token bridging, token submission, Optimism Superchain, token deployment, add token to Base]
---

# The Base Token List
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/block-explorers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Block Explorers
slug: /tools/block-explorers
description: Documentation for block explorers for the Base network.
keywords: [block explorers, base block explorer, base block explorers, Base blockchain, Base network, Base mainnet, Base testnet, smart contract analysis, transaction tracking, transaction details, Blockscout, Etherscan, Basescan]
---

# Block Explorers
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/bridge-faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Bridge FAQ
slug: /tools/bridge-faq
description: An FAQ for Base Bridge, detailing its features, usage, compatibility with Ethereum wallets, transaction processes, fees, benefits, risks, and guidelines for new users.
keywords: [Base Bridge, FAQ, frequently asked questions, bridging to base, how to bridge to base, Ethereum, blockchain technology, digital asset transfer, cryptocurrency, wallet compatibility, transaction security, network fees]
---

# Base Bridge FAQ
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/bridges-mainnet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Mainnet
slug: /tools/bridges
description: Documentation for bridging assets to the Base mainnet. This page covers how to bridge ETH and ERC-20s between Ethereum mainnet and Base mainnet, with essential cautions and contract information.
keywords: [Base, Base network, bridging, bridge to base, bridge eth, bridge eth to base, Base Bridge, Wormhole Token Bridge, Ethereum Mainnet, Base Mainnet, ETH, ERC-20 tokens, asset bridging]
---

# Bridges
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/bridges-testnet.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Testnet
slug: /tools/bridges-testnet
description: Documentation for bridging assets to the Base testnet. This page covers how to bridge ETH and ERC-20s between Ethereum testnet and Base testnet, with essential cautions and contract information.
keywords: [Base, Base network, bridging, bridge to base, bridge eth, bridge eth to base, Base Bridge, Wormhole Token Bridge, Ethereum Goerli, Base Goerli, Ethereum Sepolia, Base Sepolia, ETH, ERC-20 tokens, Base Testnet, asset bridging]
---

# Bridges
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/cross-chain.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Cross-chain
slug: /tools/cross-chain
description: Documentation for cross-chain communication and messaging on the Base network. This page covers integrating tools like LayerZero with Base for web3 transactions, cross-chain messaging, and secure blockchain communication.
keywords: [cross-chain, cross chain, crosschain messaging cross-chain messaging, omnichain, omni-chain, superchain, LayerZero, Axelar, Wormhole, web3 transactions, blockchain communication, Base Mainnet, Base Testnet, interchain connectivity, blockchain interoperability]
---

# Cross-chain
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/data-indexers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Data Indexers
slug: /tools/data-indexers
description: Documentation for data indexing platforms for Base network.
keywords: [data indexers, data indexer, indexing data, Base network, Base, Base mainnet, Base testnet, blockchain data, Covalent, SubQuery, The Graph, GraphQL, EVM chains]
---

# Data Indexers
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/ethers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: ethers.js
slug: /tools/ethers
description: Documentation for using ethers.js, a JavaScript library for EVM-compatible blockchain interactions. This page covers installation, setup, connecting to the Base network, reading and writing blockchain data, and interacting with smart contracts.
keywords: [ethers.js, JavaScript library, Base network, Base mainnet, Base testnet, smart contracts, EVM-compatible, blockchain, JsonRpcProvider, Signer, ABI, interacting with smart contract]
---

# ethers.js
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/foundry.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Foundry
slug: /tools/foundry
description: Documentation for Foundry, a toolchain for smart contract development. Provides instructions on deploying and verifying contracts on Base's mainnet and testnet using Foundry.
keywords: [Foundry, Forge, Foundry Book, smart contract development, toolchain, Base, Base mainnet, Base testnet, Base network, RPC URL, chain id, deploying contracts, verifying contracts, mainnet, testnet]
---

# Foundry
Expand Down
4 changes: 3 additions & 1 deletion apps/base-docs/docs/tools/hardhat.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Hardhat
slug: /tools/hardhat
description: Documentation for configuring Hardhat for smart contract development on Base, including setup instructions for mainnet, testnet, and local development environments.
keywords: [Hardhat, Base, Base network, Base mainnet, Base testnet, hardhat config, hardhat configuration, Ethereum development, smart contract, deployment, mainnet, testnet, local development]
---

# Hardhat
Expand All @@ -20,7 +22,7 @@ networks: {
// for mainnet
"base-mainnet": {
url: 'https://mainnet.base.org',
accounts: [process.env.WALLET_KEY as string],
accounts: [process.env.PRIVATE_KEY as string],
gasPrice: 1000000000,
},
// for testnet
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/network-faucets.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Network Faucets
slug: /tools/network-faucets
description: Documentation for Testnet Faucets for the Base network. Details how to obtain Base testnet ETH.
keywords: [network faucets, Base Goerli, Base Sepolia, testnet ETH, Base testnet, Coinbase Faucet, Superchain Faucet, Bware Labs Faucet, QuickNode Faucet, LearnWeb3 Faucet, Ethereum Mainnet, testnet resources]
---

# Network Faucets
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/node-providers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Node Providers
slug: /tools/node-providers
description: Documentation for Node Providers for the Base network. Including details on their services, supported networks, and pricing plans.
keywords: [Node Providers, Base, Base network, Base node, hosted nodes, archival nodes, RPC, RPC node, RPC URL, RPC endpoints, blockchain services, blockchain infrastructure, developer tools, API, mainnet, testnet, pricing plans, Web3 infrastructure]
---

# Node Providers
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/onramps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Onramps
slug: /tools/onramps
description: Documentation for fiat-to-crypto onramps for the Base network.
keywords: [fiat-to-crypto onramps, crypto onramp, onramps, Base, Base network, cryptocurrency, ETH on Base, payment gateway, payments, fiat to crypto, fiat, Coinbase Pay, MoonPay, Onramp]
---

# Onramps
Expand Down
2 changes: 2 additions & 0 deletions apps/base-docs/docs/tools/oracles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Oracles
slug: /tools/oracles
description: Documentation for various blockchain oracles for Base. Including support for price feeds and verifiable random functions (VRF).
keywords: [Oracles, Oracle, Base, Base Mainnet, Base Testnet, Base network, Chainlink, Pyth, VRF, verifiable random function, generate random numbers, RNG, true randomness, price feeds, data feeds]
---

# Oracles
Expand Down
Loading

0 comments on commit 76212b8

Please sign in to comment.