Skip to content

docs: improve documentation formatting #858

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0x4tl4nt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve documentation formatting #858

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/snippets/learning-objectives.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

- Install and create a new Hardhat project with Typescript support
- Describe the organization and folder structure of a Hardhat project
- List the use and properties of hardhat.config.ts
- List the use and properties of `hardhat.config.ts`

### [Testing with Hardhat and Typechain](/learn/hardhat/hardhat-testing/hardhat-testing-sbs)

Expand All @@ -35,8 +35,8 @@

### [Deploying Smart Contracts](/learn/hardhat/hardhat-deploy/hardhat-deploy-sbs)

- Deploy a smart contract to the Base Sepolia Testnet with hardhat-deploy
- Deploy a smart contract to the Sepolia Testnet with hardhat-deploy
- Deploy a smart contract to the Base Sepolia Testnet with `hardhat-deploy`
- Deploy a smart contract to the Sepolia Testnet with `hardhat-deploy`
- Use BaseScan to view a deployed smart contract

### [Verifying Smart Contracts](/learn/hardhat/hardhat-verify/hardhat-verify-sbs)
Expand All @@ -53,11 +53,11 @@
### ['Introduction to Remix'](/learn/introduction-to-solidity/introduction-to-remix)

- List the features, pros, and cons of using Remix as an IDE
- Deploy and test the Storage.sol demo contract in Remix
- Deploy and test the `Storage.sol` demo contract in Remix

### [Deployment in Remix](/learn/introduction-to-solidity/deployment-in-remix)

- Deploy and test the Storage.sol demo contract in Remix
- Deploy and test the `Storage.sol` demo contract in Remix

### [Hello World](/learn/contracts-and-basic-functions/hello-world-step-by-step)

Expand Down Expand Up @@ -121,8 +121,8 @@

### [Function Visibility and State Mutability](/learn/advanced-functions/function-visibility)

- Categorize functions as public, private, internal, or external based on their usage
- Describe how pure and view functions are different than functions that modify storage
- Categorize functions as `public`, `private`, `internal`, or `external` based on their usage
- Describe how `pure` and `view` functions are different than functions that modify storage

### [Function Modifiers](/learn/advanced-functions/function-modifiers)

Expand All @@ -145,7 +145,7 @@

### [Abstract Contracts](/learn/inheritance/abstract-contracts-sbs)

- Use the virtual, override, and abstract keywords to create and use an abstract contract
- Use the `virtual`, `override`, and `abstract` keywords to create and use an abstract contract

### [Imports](/learn/imports/imports-sbs)

Expand Down Expand Up @@ -173,9 +173,9 @@

### [Address and Payable in Solidity](/learn/address-and-payable/address-and-payable)

- Differentiate between address and address payable types in Solidity
- Differentiate between `address` and `address payable` types in Solidity
- Determine when to use each type appropriately in contract development
- Employ address payable to send Ether and interact with payable functions
- Employ `address payable` to send Ether and interact with payable functions

### [Minimal Token](/learn/token-development/minimal-tokens/minimal-token-sbs)

Expand Down Expand Up @@ -250,4 +250,4 @@

- Implement wagmi's `useSimulateContract` and `useWriteContract` to send transactions to a smart contract
- Configure the options in `useSimulateContract` and `useWriteContract`
- Call a smart contract function on-demand using the write function from `useWriteContract`, with arguments and a value
- Call a smart contract function on-demand using the write function from `useWriteContract`, with arguments and a value