add and update page descriptions

solana-foundation · Oct 29, 2024 · abfd725 · abfd725
1 parent 7211605
commit abfd725
Show file tree

Hide file tree

Showing 22 changed files with 90 additions and 9 deletions.
diff --git a/docs/advanced/lookup-tables.md b/docs/advanced/lookup-tables.md
@@ -1,7 +1,10 @@
 ---
 sidebarSortOrder: 4
 title: Address Lookup Tables
-description: ""
+description:
+  Learn how to use Solana Address Lookup Tables (ALTs) to efficiently handle up
+  to 64 addresses per transaction. Create, extend, and utilize lookup tables
+  using web3.js.
 ---
 
 Address Lookup Tables, commonly referred to as "_lookup tables_" or "_ALTs_" for

diff --git a/docs/advanced/retry.md b/docs/advanced/retry.md
@@ -3,6 +3,11 @@ sidebarSortOrder: 2
 title: Retrying Transactions
 altRoutes:
   - /docs/core/transactions/retry
+description:
+  Learn how to handle dropped transactions and implement custom retry logic on
+  Solana. This guide covers transaction rebroadcasting, preflight checks, and
+  best practices for managing transaction retries to ensure reliable transaction
+  processing on the Solana blockchain.
 ---
 
 # Retrying Transactions

diff --git a/docs/clients/javascript-reference.md b/docs/clients/javascript-reference.md
@@ -1,5 +1,8 @@
 ---
 title: Web3.js API Examples
+description:
+  Learn how to interact with the Solana blockchain using the @solana/web3.js
+  library through practical code samples and explanations.
 ---
 
 ## Web3 API Reference Guide

diff --git a/docs/clients/javascript.md b/docs/clients/javascript.md
@@ -2,6 +2,10 @@
 sidebarLabel: JavaScript / TypeScript
 title: JavaScript Client for Solana
 sidebarSortOrder: 2
+description:
+  Learn how to interact with Solana using the JavaScript/TypeScript client
+  library (@solana/web3.js). This guide covers wallet connections, transactions,
+  and custom program interactions with code examples.
 ---
 
 ## What is Solana-Web3.js?

diff --git a/docs/clients/rust.md b/docs/clients/rust.md
@@ -2,6 +2,7 @@
 sidebarLabel: Rust
 title: Rust Client for Solana
 sidebarSortOrder: 1
+description: Learn how to use Solana's Rust crates for development.
 ---
 
 Solana's Rust crates are

diff --git a/docs/core/accounts.md b/docs/core/accounts.md
@@ -2,6 +2,11 @@
 sidebarSortOrder: 1
 sidebarLabel: Solana Account Model
 title: Solana Account Model
+description:
+  Learn about Solana's account model, including how accounts store data and
+  programs, rent mechanics, account ownership, and the relationship between
+  programs and data accounts. Understand the core concepts of Solana's key-value
+  storage system.
 ---
 
 On Solana, all data is stored in what are referred to as "accounts”. The way

diff --git a/docs/core/clusters.md b/docs/core/clusters.md
@@ -2,6 +2,10 @@
 sidebarLabel: Clusters & Endpoints
 title: Clusters and Public RPC Endpoints
 sidebarSortOrder: 8
+description:
+  Learn about Solana's network clusters (Devnet, Testnet, and Mainnet Beta),
+  their public RPC endpoints, rate limits, and use cases. Learn how to connect
+  to different Solana networks for development, testing, and production.
 ---
 
 The Solana blockchain has several different groups of validators, known as

diff --git a/docs/core/cpi.md b/docs/core/cpi.md
@@ -2,6 +2,10 @@
 title: Cross Program Invocation (CPI)
 sidebarLabel: Cross Program Invocation
 sidebarSortOrder: 6
+description:
+  Learn about Cross Program Invocation (CPI) on Solana - how programs can call
+  instructions on other programs, handle PDA signers, and compose functionality
+  across the Solana network.
 ---
 
 A Cross Program Invocation (CPI) refers to when one program invokes the

diff --git a/docs/core/fees.md b/docs/core/fees.md
@@ -2,9 +2,9 @@
 title: Fees on Solana
 sidebarSortOrder: 3
 description:
-  "Your guide to transaction fees on Solana -- small fees paid to process
-  instructions on the network, based on computation and an optional
-  prioritization fee."
+  Learn about Solana's fee structure including transaction fees, prioritization
+  fees, and rent costs. Understand how fees are calculated, collected and
+  distributed across the network.
 keywords:
   - instruction fee
   - processing fee

diff --git a/docs/core/index.md b/docs/core/index.md
@@ -2,8 +2,9 @@
 title: Core Concepts
 sidebarSortOrder: 2
 description:
-  "Understanding these core concepts are very important to maximize your success
-  as a Solana blockchain developer."
+  Learn essential Solana blockchain concepts including accounts, transactions,
+  programs, programd derived addresses, cross program invocations, and how
+  tokens work on Solana.
 ---
 
 Build a strong understanding of the core concepts that make Solana different

diff --git a/docs/core/pda.md b/docs/core/pda.md
@@ -2,6 +2,10 @@
 title: Program Derived Address (PDA)
 sidebarLabel: Program Derived Address
 sidebarSortOrder: 5
+description:
+  Learn about Program Derived Addresses (PDAs) on Solana - deterministic account
+  addresses that enable secure program signing. Understand PDA derivation,
+  canonical bumps, and how to create PDA accounts.
 ---
 
 Program Derived Addresses (PDAs) provide developers on Solana with two main use

diff --git a/docs/core/programs.md b/docs/core/programs.md
@@ -2,6 +2,10 @@
 title: Programs
 sidebarLabel: Programs on Solana
 sidebarSortOrder: 4
+description:
+  Learn about Solana programs (smart contracts) and how to develop them using
+  Rust or the Anchor framework. Understand program deployment, upgrades, and
+  verification on the Solana network.
 ---
 
 In the Solana ecosystem, "smart contracts" are called programs. Each

diff --git a/docs/core/tokens.md b/docs/core/tokens.md
@@ -1,6 +1,10 @@
 ---
 title: "Tokens on Solana"
 sidebarSortOrder: 7
+description:
+  Learn about Solana tokens (SPL Tokens) including fungible and non-fungible
+  tokens, Token Program, Token Extensions Program, mint accounts, token
+  accounts, and practical examples for creating and managing tokens on Solana.
 ---
 
 Tokens are digital assets that represent ownership over diverse categories of

diff --git a/docs/core/transactions.md b/docs/core/transactions.md
@@ -1,6 +1,10 @@
 ---
 title: "Transactions and Instructions"
 sidebarSortOrder: 2
+description:
+  Learn about Solana transactions and instructions - the fundamental building
+  blocks for interacting with the Solana blockchain. Understand transaction
+  structure and instruction composition with practical examples.
 ---
 
 On Solana, we send [transactions](/docs/core/transactions#transaction) to

diff --git a/docs/intro/installation.md b/docs/intro/installation.md
@@ -3,8 +3,10 @@ title: Installation
 seoTitle: Install the Solana CLI and Anchor
 sidebarSortOrder: 1
 description:
-  "Easily setup your local development environment for Solana development on
-  Linux, Mac or Windows. Including installing Rust, the Solana CLI, and Anchor."
+  A comprehensive guide to setting up your local Solana development environment.
+  Learn how to install Rust, the Solana CLI, and Anchor Framework on Windows
+  (WSL), Linux, and Mac. Includes step-by-step instructions for creating
+  wallets, requesting airdrops, and running a local validator.
 altRoutes:
   - /developers/guides/getstarted/setup-local-development
   - /docs/install

diff --git a/docs/intro/quick-start/cross-program-invocation.md b/docs/intro/quick-start/cross-program-invocation.md
@@ -2,6 +2,12 @@
 sidebarLabel: Cross Program Invocation
 title: Cross Program Invocation
 sidebarSortOrder: 5
+description:
+  Learn how to implement Cross Program Invocations (CPIs) in Solana programs
+  using the Anchor framework. This tutorial demonstrates how to transfer SOL
+  between accounts, interact with the System Program, and handle Program Derived
+  Addresses (PDAs) in CPIs. Perfect for developers looking to build composable
+  Solana programs.
 ---
 
 In this section, we'll update the CRUD program from the previous PDA section to

diff --git a/docs/intro/quick-start/deploying-programs.md b/docs/intro/quick-start/deploying-programs.md
@@ -2,6 +2,11 @@
 sidebarLabel: Deploying Programs
 title: Deploying Your First Solana Program
 sidebarSortOrder: 3
+description:
+  Learn how to build, deploy, and test your first Solana program using the
+  Anchor framework and Solana Playground. This beginner-friendly guide walks
+  through creating a simple program, deploying it to devnet, running tests, and
+  closing the program.
 ---
 
 In this section, we'll build, deploy, and test a simple Solana program using the

diff --git a/docs/intro/quick-start/index.md b/docs/intro/quick-start/index.md
@@ -2,6 +2,10 @@
 sidebarLabel: Quick Start
 title: Solana Quick Start Guide
 sidebarSortOrder: 0
+description:
+  Learn Solana development basics. Create your first program, understand
+  accounts, send transactions, and explore PDAs and CPIs using Solana Playground
+  - no installation required.
 ---
 
 Welcome to the Solana Quick Start Guide! This hands-on guide will introduce you

diff --git a/docs/intro/quick-start/program-derived-address.md b/docs/intro/quick-start/program-derived-address.md
@@ -2,6 +2,12 @@
 sidebarLabel: Program Derived Address
 title: Program Derived Address
 sidebarSortOrder: 4
+description:
+  Learn how to build a CRUD (Create, Read, Update, Delete) Solana program using
+  Program Derived Addresses (PDAs) and the Anchor framework. This step-by-step
+  guide demonstrates how to create, update, and delete on-chain message accounts
+  using PDAs, implement account validation, and write tests. Perfect for
+  developers looking to understand how to use PDAs in Solana programs.
 ---
 
 In this section, we'll walk through how to build a basic CRUD (Create, Read,

diff --git a/docs/intro/quick-start/reading-from-network.md b/docs/intro/quick-start/reading-from-network.md
@@ -2,6 +2,11 @@
 sidebarLabel: Reading from Network
 title: Reading from Network
 sidebarSortOrder: 1
+description:
+  Learn how to read data from the Solana blockchain network. This guide covers
+  fetching wallet accounts, program accounts, and token mint accounts using
+  JavaScript/TypeScript, with practical examples using the Solana web3.js
+  library.
 ---
 
 Now, let's explore how to read data from the Solana network. We'll fetch a few

diff --git a/docs/intro/quick-start/writing-to-network.md b/docs/intro/quick-start/writing-to-network.md
@@ -2,6 +2,10 @@
 sidebarLabel: Writing to Network
 title: Writing to Network
 sidebarSortOrder: 2
+description:
+  Learn how to interact with the Solana network by sending transactions and
+  instructions. Follow step-by-step examples to transfer SOL tokens and create
+  new tokens using the System Program and Token Extensions Program.
 ---
 
 Now that we've explored reading from the Solana network, let's learn how to

diff --git a/docs/programs/anchor/index.md b/docs/programs/anchor/index.md
@@ -1,6 +1,9 @@
 ---
 title: Getting Started with Anchor
-description: Getting Started with Anchor
+description:
+  Learn how to build Solana programs using the Anchor framework. This
+  comprehensive guide covers creating, building, testing, and deploying Solana
+  smart contracts with Anchor.
 sidebarLabel: Anchor Framework
 sidebarSortOrder: 1
 altRoutes: