Merge pull request #1547 from onflow/cleanup_docs_cws

Small cleanups reflecting style guide meeting

Author: cshannon1218

docs/blockchain-development-tutorials/cadence/cadence-advantages/compose-with-cadence-transactions.md

@@ -19,9 +19,7 @@ keywords:
   - Flowscan
 ---
 
-# Compose wth Cadence Transactions
-
-## Overview
+# Compose wth Cadence transactions
 
 In this tutorial, you'll **compose with someone else's contracts** on Flow testnet. You'll write a Cadence transaction that reads public state from a contract named `Counter` and only increments the counter when it is odd. Then you'll extend the transaction to mint NFTs when the counter is odd, demonstrating how to compose multiple contracts in a single transaction. Everything runs against testnet using the Flow CLI and the dependency manager.
 
@@ -46,7 +44,7 @@ After you complete this guide, you will be able to:
   - Create: https://developers.flow.com/build/tools/flow-cli/commands#create-accounts
   - Fund: https://developers.flow.com/build/tools/flow-cli/commands#fund-accounts
 
-## Getting Started
+## Get started
 
 Create a [new project] with the [Flow CLI]:
 
@@ -231,13 +229,13 @@ You could trigger this same transaction **from an app** and **signed by a wallet
 
 ---
 
-## Extend with NFT Minting
+## Extend with NFT minting
 
 Now let's take our composition to the next level by adding NFT minting functionality when the counter is odd. We'll use an example NFT contract that's already deployed on testnet.
 
 This is a silly use case, but it demonstrates the complex use cases you can add to your apps, after contract deployment, and even if you aren't the author of any of the contracts!
 
-### Install the NFT Contract
+### Install the NFT contract
 
 First, let's install the ExampleNFT contract dependency:
 
@@ -251,7 +249,7 @@ This repository uses different deployments for core contracts than those that th
 
 :::
 
-### Understanding NFT Minting
+### Understand NFT minting
 
 Let's look at how NFT minting works with this contract. The [MintExampleNFT transaction] shows the pattern:
 
@@ -291,7 +289,7 @@ transaction(
 
 You can copy this functionality and adapt it for our use case.
 
-### Update the IncrementIfOdd Transaction
+### Update the IncrementIfOdd transaction
 
 Now let's update our `IncrementIfOdd` transaction to mint an NFT when the counter is odd. You can either modify the existing transaction or create a new one:
 
@@ -341,7 +339,7 @@ transaction() {
 }
 ```
 
-### Setup NFT Collection
+### Setup NFT collection
 
 Before you can mint NFTs, set up an NFT collection in your account. Create a transaction to do this:
 
@@ -392,7 +390,7 @@ You may need to run the regular `IncrementCounter` transaction first to get an o
 flow transactions send cadence/transactions/IncrementCounter.cdc --signer testnet-account --network testnet
 ```
 
-### View Your NFT
+### View your NFT
 
 Click the transaction link in the console to view the transaction in [testnet Flowscan]. After you run the transaction **while the counter is odd**, you'll see an NFT in the `Asset Transfers` tab.
 

docs/blockchain-development-tutorials/cadence/cadence-advantages/native-data-availibility-with-cadence-scripts.md

@@ -23,8 +23,6 @@ keywords:
 
 # Native Data Availability With Cadence Scripts
 
-## Overview
-
 In Solidity, you can only retrieve data from **view** functions that the contract author anticipated and included in the original contract. If the exact query you want is not exposed, teams typically rely on a _data availability service_ such as The Graph, Covalent, Alchemy Enhanced APIs, Reservoir, or NFTScan to compute and serve that view.
 
 In Cadence, **scripts** are general-purpose read programs. They can traverse public account storage, read public capabilities, and compose types from multiple contracts to answer new questions without modifying those contracts. You are not limited to the pre-written surface area of a single contract's views.
@@ -62,7 +60,7 @@ If you are new to [_Hybrid Custody_], the high-level idea is that in Cadence, a
 
 :::
 
-## Getting Started
+## Get started
 
 Create a new Flow project and generate a script file:
 
@@ -83,7 +81,7 @@ We will **revise one script file** in four passes, and run it after each step. T
 
 ---
 
-## Querying the account to find child accounts
+## Query the account to find child accounts
 
 To start, write a script that borrows the parent's _Hybrid Custody_ manager and returns the child addresses it controls. This verifies that imports resolve and that the parent account is configured as expected.
 
@@ -427,7 +425,7 @@ This demonstrates how you can easily modify Cadence scripts to answer different
 - If you see empty results in Step 4, confirm `isTopShot` matches the identifiers you observed in Step 3.
 - If you are not using _Hybrid Custody_, you can adapt Steps 2-4 to use `getAccount(child)` and scan **publicly exposed** `{NonFungibleToken.CollectionPublic}` capabilities, but you will not be able to assert provider access.
 
-## How This Compares to Solidity
+## How This compares to Solidity
 
 - **Solidity views are fixed**: You can only retrieve what the contract author exposed via `view` or `pure` functions. If you need a different aggregation or cross-contract traversal, you typically rely on a _data availability service_ or write a new contract to expose that view.
 - **Cadence scripts are flexible**: You compose types across modules, traverse account storage, and read public capabilities at query time. You do not need to redeploy contracts to answer new questions.

docs/blockchain-development-tutorials/cadence/cadence-advantages/upgrading-cadence-contracts.md

@@ -18,8 +18,6 @@ keywords:
 
 # Upgrading Cadence Contracts
 
-## Overview
-
 In Cadence, you can upgrade deployed contracts by adding new functionality while preserving existing state and maintaining the same contract address. Unlike other blockchain platforms that require complex proxy patterns or complete redeployment, Cadence allows you to seamlessly extend your contracts with new functions and events through multiple incremental upgrades.
 
 This tutorial demonstrates how to upgrade a deployed contract through two scenarios: 
@@ -45,11 +43,11 @@ After you complete this guide, you will be able to:
 - A **funded testnet account** to deploy and update contracts.
   - See [Create accounts] and [Fund accounts] in the Flow CLI commands.
 
-## Contract Upgrade Overview
+## Contract upgrade overview
 
 Cadence provides a sophisticated contract upgrade system that allows you to modify deployed contracts while ensuring data consistency and preventing runtime crashes. It's crucial for successful upgrades that you understand what you can and can't change.
 
-### What You CAN Upgrade
+### What you CAN upgrade
 
 - **Add new functions** - Extend contract functionality with new methods.
 - **Add new events** - Emit additional events for monitoring and indexing.
@@ -59,15 +57,15 @@ Cadence provides a sophisticated contract upgrade system that allows you to modi
 - **Change access modifiers** - Update visibility of functions and fields.
 - **Reorder existing fields** - Field order doesn't affect storage.
 
-### What You CANNOT Upgrade
+### What you CANNOT upgrade
 
 - **Add new fields** - Would cause runtime crashes when loading existing data.
 - **Change field types** - Would cause deserialization errors.
 - **Remove existing fields** - Fields become inaccessible, but data remains.
 - **Change enum structures** - Raw values must remain consistent.
 - **Change contract name** - Contract address must remain the same.
 
-### Why These Restrictions Exist
+### Why these restrictions exist
 
 The [Cadence Contract Updatability documentation](https://cadence-lang.org/docs/language/contract-updatability) explains that these restrictions prevent:
 
@@ -78,7 +76,7 @@ The [Cadence Contract Updatability documentation](https://cadence-lang.org/docs/
 
 The validation system ensures that existing stored data remains valid and accessible after upgrades.
 
-## Getting Started
+## Get started
 
 Create a new Flow project for this tutorial:
 
@@ -89,7 +87,7 @@ flow init upgrading-contracts-tutorial
 
 Follow the prompts and create a `Basic Cadence project (no dependencies)` then open the new project in your editor.
 
-### Create and Fund Testnet Account
+### Create and fund testnet account
 
 You'll need a funded testnet account to deploy and update contracts. In a terminal in the root of your project folder:
 
@@ -120,7 +118,7 @@ The faucet provides free testnet tokens for development and testing purposes. Th
 
 ---
 
-## Deploy the Initial Counter Contract
+## Deploy the initial counter contract
 
 To start, let's deploy a simple Counter contract to testnet.
 
@@ -165,7 +163,7 @@ access(all) contract Counter {
 }
 ```
 
-### Configure Deployment
+### Configure deployment
 
 Add testnet deployment configuration to your `flow.json`:
 
@@ -210,7 +208,7 @@ Counter -> 0x9942a81bc6c3c5b7 (contract deployed successfully)
 🎉 All contracts deployed successfully
 ```
 
-### Test the Initial Contract
+### Test the initial contract
 
 Use the provided transaction to test initial functionality:
 
@@ -280,11 +278,11 @@ Events:
 
 ---
 
-## Upgrade the Contract - Part 1: Adding Event for Even Numbers
+## Upgrade the contract - Part 1: Add event for even numbers
 
 Let's start with a realistic scenario: What if we've realized it's very important to our users that they know when the counter reaches an even number, but we forgot to add an event for that case? Let's add that functionality first.
 
-### Modify the Counter Contract - First Upgrade
+### Modify the Counter contract - first upgrade
 
 Update `cadence/contracts/Counter.cdc` to add the new event and enhance the existing `increment()` function:
 
@@ -330,7 +328,7 @@ access(all) contract Counter {
 }
 ```
 
-### Key Changes Made - Part 1
+### Key changes made - part 1
 
 This first upgrade adds:
 
@@ -346,11 +344,11 @@ This demonstrates how you can add new behavior and modify existing function beha
 
 ---
 
-## Update the Deployed Contract - Part 1
+## Update the deployed contract - Part 1
 
 Now let's update the deployed contract on testnet using the Flow CLI update command with our first upgrade.
 
-### Update the Contract
+### Update the contract
 
 Use the [Flow CLI update contract command] to upgrade your deployed contract:
 
@@ -389,7 +387,7 @@ The contract successfully updated! Notice that:
 
 :::
 
-### Test the First Upgrade
+### Test the first upgrade
 
 Let's test the new event functionality. Create a simple transaction to test the enhanced `increment()` function:
 
@@ -429,11 +427,11 @@ Notice that:
 
 ---
 
-## Upgrade the Contract - Part 2: Adding More Functionality
+## Upgrade the contract - Part 2: add more functionality
 
 Now that we've successfully added the even number event, let's add more functionality to our contract. This demonstrates how you can make multiple incremental upgrades to extend your contract's capabilities.
 
-### Modify the Counter Contract - Second Upgrade
+### Modify the Counter contract - second upgrade
 
 Update `cadence/contracts/Counter.cdc` to add the additional functionality:
 
@@ -502,7 +500,7 @@ access(all) contract Counter {
 }
 ```
 
-### Key Changes Made - Part 2
+### Key changes made - part 2
 
 This second upgrade adds:
 
@@ -513,11 +511,11 @@ This second upgrade adds:
 
 ---
 
-## Update the Deployed Contract - Part 2
+## Update the deployed contract - Part 2
 
 Now let's update the deployed contract with our second upgrade.
 
-### Update the Contract Again
+### Update the contract again
 
 Use the [Flow CLI update contract command] to upgrade your deployed contract with the additional functionality:
 
@@ -557,7 +555,7 @@ The contract successfully updated again! Notice that:
 
 :::
 
-### Verify the Update
+### Verify the update
 
 Let's verify that the existing functionality still works and the new functionality is available.
 
@@ -599,11 +597,11 @@ Notice that:
 
 ---
 
-## Test the New Functionality
+## Test the new functionality
 
 Now let's create a transaction to test the new even counter functionality.
 
-### Create Test Transaction
+### Create test transaction
 
 Create a new transaction to test the upgraded functionality:
 
@@ -651,7 +649,7 @@ transaction {
 }
 ```
 
-### Run the Test Transaction
+### Run the test transaction
 
 Execute the transaction to test the new functionality:
 
@@ -667,7 +665,7 @@ You will see logs that show:
 - The original `increment()` function still working normally
 - The new `CounterIncrementedToEven` event being emitted when incrementing results in an even number
 
-### Verify Final State
+### Verify final state
 
 Run the check script again to see the final state:
 
@@ -689,11 +687,11 @@ This confirms that:
 
 ---
 
-## Understanding Contract Upgrades in Cadence
+## Understand contract upgrades in Cadence
 
 Cadence provides a sophisticated contract upgrade system that ensures data consistency while allowing controlled modifications. The [Cadence Contract Updatability documentation] provides comprehensive details about the validation rules and restrictions.
 
-### What You Can Upgrade
+### What you can upgrade
 
 When you upgrade Cadence contracts, you can:
 
@@ -707,7 +705,7 @@ When you upgrade Cadence contracts, you can:
 - **Change access modifiers** of fields and functions
 - **Reorder existing fields** (order doesn't affect storage)
 
-### What You Cannot Change
+### What You cannot change
 
 There are important limitations to contract upgrades:
 
@@ -734,9 +732,9 @@ The validation system focuses on preventing runtime inconsistencies with stored
 
 :::
 
-### Advanced Upgrade Patterns
+### Advanced upgrade patterns
 
-#### The `#removedType` Pragma
+#### The `#removedType` pragma
 
 For cases where you need to remove a type declaration (which is normally invalid), Cadence provides the `#removedType` pragma. This allows you to "tombstone" a type, which prevents it from being re-added with the same name:
 
@@ -755,7 +753,7 @@ This pragma:
 - **Cannot be removed** after you add it (prevents circumventing restrictions).
 - **Only works with composite types**, not interfaces.
 
-#### Enum Upgrade Restrictions
+#### Enum upgrade restrictions
 
 Enums have special restrictions due to their raw value representation:
 
@@ -764,7 +762,7 @@ Enums have special restrictions due to their raw value representation:
 - **Cannot change the raw type** of an enum.
 - **Cannot change enum case names** (would change stored values' meaning).
 
-### Best Practices
+### Best practices
 
 When you upgrade contracts:
 
@@ -779,7 +777,7 @@ When you upgrade contracts:
 
 ---
 
-## Why This Matters
+## Why this matters
 
 Cadence's contract upgrade model provides several advantages: