Skip to content

Commit c351107

Browse files
fix: correct typos in documentation
- Fix 'Descrition' -> 'Description' in solidity-modules.mdx - Fix 'facet modules' -> 'facet module' (singular) in design-for-composition.mdx - Fix 'ERC20BridgableFacet' -> 'ERC20BridgeableFacet' in reusable-facet-logic.mdx - Fix numbering in composable-facets.mdx (1, 3, 4 -> 1, 2, 3) - Fix 'It's own' -> 'Its own' in diamond-contracts.mdx
1 parent 3187148 commit c351107

File tree

5 files changed

+6
-6
lines changed

5 files changed

+6
-6
lines changed

website/docs/design/design-for-composition.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ We focus on building **small, independent, and easy-to-read facets**. Each facet
2323
## Writing Facet Modules
2424

2525
1. Facet modules are self-contained code units. They do not import anything.
26-
2. Each facet should have one corresponding facet modules.
26+
2. Each facet should have one corresponding facet module.
2727
3. Facet modules are used to initialize facets on deployment and during upgrades.
2828
4. Facet modules are also used to integrate custom facets with Compose facets.
2929
5. Facet modules have one or more functions which are used to initialize storage variables during deployment.

website/docs/foundations/composable-facets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ On-chain facets are the **building blocks** of Compose. Like LEGO bricks, they'r
7878
## Composability Benefits
7979

8080
1. **Start Simple, then Scale**: Begin with core functionality, add features
81-
3. **Increase Confidence**: Use tested, audited facets from the Compose library to build your project
82-
4. **Architectural Flexibility**: Same facets, infinite configurations based on your project needs
81+
2. **Increase Confidence**: Use tested, audited facets from the Compose library to build your project
82+
3. **Architectural Flexibility**: Same facets, infinite configurations based on your project needs
8383

8484
### Composition vs. Inheritance
8585

website/docs/foundations/diamond-contracts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A diamond contract is a smart contract made from multiple small building blocks
1818

1919
A diamond has:
2020
- One address
21-
- It's own data storage
21+
- Its own data storage
2222
- Multiple facets providing functionality
2323

2424
Below is a diagram showing a diamond with multiple facets.

website/docs/foundations/reusable-facet-logic.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Suppose you want to create a new ERC-20 token that supports gasless approvals (p
4040

4141
With Compose, you:
4242

43-
1. **Select existing facets**: `ERC20Facet`, `ERC20PermitFacet`, and `ERC20BridgableFacet` are already deployed on-chain
43+
1. **Select existing facets**: `ERC20Facet`, `ERC20PermitFacet`, and `ERC20BridgeableFacet` are already deployed on-chain
4444
2. **Provide initialization data**: your token's name, symbol, and total supply
4545
3. **Deploy your diamond**: a small proxy contract that references the facet addresses and logic
4646

website/docs/foundations/solidity-modules.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 3
33
title: Solidity Modules
4-
description: Descrition of what Solidity modules are and how they are used in Compose.
4+
description: Description of what Solidity modules are and how they are used in Compose.
55
---
66

77

0 commit comments

Comments
 (0)