Skip to content

Commit c52627d

Browse files
fix: grammar issues (#64)
This PR addresses various grammar issues in the documentation. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Made extensive editorial and stylistic improvements across multiple documentation files, including grammar, punctuation, spelling (with British English variants), and clarity enhancements. * Standardized terminology and formatting, corrected typographical errors, and improved readability throughout onboarding, development, governance, interoperability, security, processes, and testing documentation. * Added placeholder note blocks to indicate upcoming content in certain knowledge base sections. * No changes to technical content, logic, or functionality were introduced. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Lumi <lumi@wonderland.xyz> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent f344972 commit c52627d

64 files changed

Lines changed: 322 additions & 315 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/🐞-bug-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ assignees: ''
99
---
1010

1111
Thanks for helping us keep the Wonderland Handbook sharp and functional 🧹
12-
If something isn’t behaving the way it shouldfrom broken links to rendering issues use this template to help us fix it fast.
12+
If something isn’t behaving the way it should: from broken links to rendering issues, use this template to help us fix it fast.
1313

1414
---
1515

sites/optimism/docs/governance/bye.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_label: Wrapping up
66

77
# Wrapping Up
88

9-
To wrap up, where the OP Stack defines *how the system runs*, governance defines *how it changes*. It encodes: who can propose, who can vote, and who can veto. And because governance must evolve with the Collective, it’s designed to be both programmable and flexiblevia modules, managers, and community experimentation.
9+
To wrap up, where the OP Stack defines *how the system runs*, governance defines *how it changes*. It encodes: who can propose, who can vote, and who can veto. And because governance must evolve with the Collective, it’s designed to be both programmable and flexible: via modules, managers, and community experimentation.
1010

1111
As you’ve seen, governance isn’t just about casting votes. It’s about trust minimization, fault tolerance, consent, and credible neutrality. The system must balance legitimacy with execution, and decentralization with security.
1212

sites/optimism/docs/governance/governance-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ By the end of this section, you should be able to answer:
2222
- What’s the difference between an approval and a vote on Optimism?
2323
- Who can propose? Who can vote? What powers are delegated?
2424
- How do proposals move through states like Pending → Active → Executed?
25-
- How is quorum calculated, and what makes a proposal “pass”?
25+
- How is quorum calculated, and what constitutes “pass”?
2626
- What is Alligator, and why is delegation logic so complicated?
2727
- What happens if a delegate tries to push a proposal that violates cycle rules?
2828
- What is permissionless governance, and what tradeoffs does it introduce?

sites/optimism/docs/governance/governor-walkthrough.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ sidebar_label: Governor Walkthrough
66

77
# The Optimism Governor Walkthrough
88

9-
The Optimism Governor is based on the OpenZeppelin’s Governor, customized to support Optimism’s governance needs: signaling proposals, customizable voting rules, subdelegations, and so on.
9+
The Optimism Governor is based on OpenZeppelin’s Governor, customized to support Optimism’s governance needs: signalling proposals, customizable voting rules, subdelegations, and so on.
1010

11-
In the long run anyone should be able to propose changes, but safeguards like delegate approvals, quorum thresholds, and timelocks are required to ensure quality and protect against manipulation.
11+
In the long run, anyone should be able to propose changes, but safeguards like delegate approvals, quorum thresholds, and timelocks are required to ensure quality and protect against manipulation.
1212

1313
Some useful resources:
1414

@@ -30,7 +30,7 @@ While proposals today are signaling-only for most types (i.e., they do not trigg
3030

3131
- **`admin`**: Owns the proxy and controls upgrades. Does not vote or propose.
3232
- **`manager`**: Can create proposals, execute them, or update system parameters.
33-
- **`voters`**: Any address with delegated OP either directly or through Alligator.
33+
- **`voters`**: Any address with delegated OP, either directly or through Alligator.
3434

3535
## Inheritance
3636

@@ -64,7 +64,7 @@ propose(...): // Standard proposal
6464
proposeWithModule(...): // Proposal with custom voting module
6565
```
6666

67-
Only the `manager` or `timelock()` can call propose. Each proposal is assigned a `proposalType`, which maps to specific quorum/approval thresholds in the `ProposalTypesConfigurator`.
67+
Only the `manager` or `timelock()` can propose. Each proposal is assigned a `proposalType`, which maps to specific quorum/approval thresholds in the `ProposalTypesConfigurator`.
6868

6969
Voting is handled via:
7070
- `castVote()`: standard token-based voting
@@ -77,7 +77,7 @@ Proposals are executed via the Timelock contract, using `execute()` or `executeW
7777

7878
### Alligator - Subdelegations
7979

80-
The Alligator enables partial delegation, a user can split their voting power across multiple delegates using absolute or relative rules. These delegations can be chained (A → B → C) and validated onchain using authority[] arrays.
80+
The Alligator enables partial delegation; a user can split their voting power across multiple delegates using absolute or relative rules. These delegations can be chained (A → B → C) and validated onchain using authority[] arrays.
8181

8282
The key structures are:
8383
- `subdelegations[from][to]`: maps delegations
@@ -102,9 +102,9 @@ Proposal thresholds are stored with 1e4 scaling (10000 = 100%). The Governor cal
102102

103103
## Votable Supply Oracle
104104

105-
Instead of total token supply, quorum is based on votable supply — the total OP that has been delegated. This is retrieved at proposal creation block and used to calculate thresholds dynamically.
105+
Instead of the total token supply, quorum is based on votable supply — the total OP that has been delegated. This is retrieved at the proposal creation block and used to calculate thresholds dynamically.
106106

107-
- **Fallback**: if `votableSupply()` returns zero, the Governor falls back to total token supply.
107+
- **Fallback**: if `votableSupply()` returns zero, the Governor falls back to the total token supply.
108108

109109
## Functions Summary
110110

@@ -125,4 +125,4 @@ Instead of total token supply, quorum is based on votable supply — the total O
125125

126126
## Future Extensions
127127

128-
We are working on an upgrade that is evolving toward permissionless proposals, enforced via `DelegatesProposalValidator` contract, it gates access to `propose()` based on delegate approvals and submission windows, allowing any qualifying participant to propose, while still preserving cycle alignment.
128+
We are working on an upgrade that is evolving toward permissionless proposals, enforced via `DelegatesProposalValidator` contract, which gates access to `propose()` based on delegate approvals and submission windows, allowing any qualifying participant to propose, while still preserving cycle alignment.

sites/optimism/docs/governance/intro-to-governance.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ sidebar_label: Governance in a nutshell
88

99
Before we get into Optimism-specific contracts, let’s zoom out.
1010

11-
On-chain governance is a mechanism for managing shared infrastructure using verifiable rules. In practice, governance contracts behave similar to multisigs, but with vote weights distributed across token holders rather than multisig signers.
11+
On-chain governance is a mechanism for managing shared infrastructure using verifiable rules. In practice, governance contracts behave similarly to multisigs, but with vote weights distributed across token holders rather than multisig signers.
1212

1313
At its core, governance is about managing change. A **proposal** is just a transaction (or set of transactions): a list of target addresses, call data, and sometimes ETH values. Token holders vote to approve or reject the proposal. If the vote passes and quorum is met, the transaction can be executed onchain. If it fails, it’s simply discarded.
1414

1515
Voting power is usually determined by the number of tokens an address holds at a specific snapshot block. Most systems also allow **delegation**, meaning you can assign your voting power to another address to vote on your behalf.
1616

17-
Some proposals affect onchain systems directly (e.g. upgrading a contract). Others are **signaling-only** (e.g. changing a community guideline or legal structure). In those cases, proposals still follow the same governance flow, but their “execution” happens through offchain coordination or manual implementation.
17+
Some proposals affect onchain systems directly (e.g. upgrading a contract). Others are **signalling-only** (e.g. changing a community guideline or legal structure). In those cases, proposals still follow the same governance flow, but their “execution” happens through offchain coordination or manual implementation.
1818

1919
## Common Terms
2020

@@ -33,7 +33,7 @@ These are the core terms used across most governance systems, including Optimism
3333
While implementations vary, the lifecycle of a proposal usually looks like this:
3434

3535
```nasm
36-
Pending ⭢ Active ⭢ Defeated ⭢ Canceled
36+
Pending ⭢ Active ⭢ Defeated ⭢ Cancelled
3737
⮑ Succeeded ⭢ Queued ⭢ Executed
3838
⮑----------⮑-------⮑ Expired
3939
```
@@ -92,12 +92,12 @@ In particular, the [`GovernorCompatibilityBravo`](https://github.com/OpenZeppeli
9292
Most governance systems in Ethereum share the same building blocks:
9393
- A voting mechanism that calculates token-weighted power at a specific block (snapshot).
9494
- A registry of proposals with metadata like start/end blocks, vote tallies, and actions.
95-
- A timelock controller that enforces a minimum delay before execution.
95+
- A time lock controller that enforces a minimum delay before execution.
9696
- A quorum and approval threshold to ensure decisions are legitimate.
9797

98-
On top of this, each protocol adds its own mechanics: delegation systems, role-based permissions, modular thresholds, and custom voting logic.
98+
On top of this, each protocol adds its mechanics: delegation systems, role-based permissions, modular thresholds, and custom voting logic.
9999

100-
Some proposals are executable, others are advisory. Some are submitted by anyone, others require approvals. Governance is always opinionated, the trick is making those opinions legible and upgradeable.
100+
Some proposals are executable, others are advisory. Some are submitted by anyone, others require approval. Governance is always opinionated; the trick is making those opinions legible and upgradeable.
101101

102102
## Limitations and Responsibilities
103103

sites/optimism/docs/governance/our-work/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This section documents active governance-related development initiatives led by
88

99
## Why it matters
1010

11-
The governance is designed to evolve. Improvements often arise from practical bottlenecks observed by delegates, contributors, and protocol developers. This section records how those pain points are being addressedthrough new contracts, improved interfaces, or procedural upgrades.
11+
The governance is designed to evolve. Improvements often arise from practical bottlenecks observed by delegates, contributors, and protocol developers. This section records how those pain points are being addressed through new contracts, improved interfaces, or procedural upgrades.
1212

1313
Each entry aims to explain:
1414

sites/optimism/docs/governance/our-work/permissionless-proposals.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ This contract wraps the proposal submission functions (`propose()` and `proposeW
3535

3636
Its responsibilities include:
3737

38-
- **Delegate approvals**: Verifies that the proposal has received enough sign-offs from top 100 delegates. Both the number of signers and their minimum voting power are configurable.
38+
- **Delegate approvals**: Verifies that the proposal has received enough sign-offs from the top 100 delegates. Both the number of signers and their minimum voting power are configurable.
3939
- **Window enforcement**: Ensures proposals are submitted within a designated submission window relative to the current voting cycle.
4040
- **GovernanceType validation**: Each proposal is tagged with a `GovernanceType`, which defines its eligibility rules, proposer constraints, and thresholds. There is no 1:1 mapping between GovernanceType and UI-facing proposal categories—one category (e.g., Protocol Upgrade) may have multiple GovernanceTypes depending on proposer roles and validation logic.
4141
- **Distribution limit**: Applies to funding proposals—checks that the requested OP does not exceed a configured limit for the cycle.
@@ -64,7 +64,7 @@ Its responsibilities include:
6464
## Risks and Uncertainties
6565

6666
- **GovernanceType complexity**: GovernanceTypes may proliferate as the system expands, especially since different proposers (e.g., Foundation vs. delegates) may have different rules for similar proposal categories. Care must be taken to manage and communicate this complexity to avoid confusion.
67-
- **Subdelegation ambiguity**: The system currently does not account for Alligator-style subdelegation. A delegate may appear in the top 100 due to delegated voting power, which may already be partially committed elsewhereleading to unclear eligibility.
67+
- **Subdelegation ambiguity**: The system currently does not account for Alligator-style subdelegation. A delegate may appear in the top 100 due to delegated voting power, which may already be partially committed elsewhere, leading to unclear eligibility.
6868
- **Centralized configuration authority (MVP)**: Governance parameters are currently set by a single role. Long-term decentralization remains a critical roadmap goal.
6969

7070
:::info reference

sites/optimism/docs/governance/the-operating-manual/the-citizens-house.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Its core responsibility is managing the Retro Funding, and, increasingly, partic
2323
Citizens are individuals who hold an attestation of citizenship, managed via Ethereum Attestation Service (EAS). Citizenship is currently:
2424
- Temporary, and may evolve through experimental iterations
2525
- Granted experimentally, often through guest voter rounds
26-
- Revocable, if criteria are no longer met or based on conduct
26+
- Revocable, if the criteria are no longer met or based on conduct
2727

2828
🔗 View the current [Citizen Schema on EAS](https://optimism.easscan.org/schema/view/0xc35634c4ca8a54dce0a2af61a9a9a5a3067398cb3916b133238c4f6ba721bc8a)
2929

@@ -48,7 +48,7 @@ The Citizens’ House governs primarily through two processes:
4848
- Missions follow clear stages: scoping → applications → review → voting → disbursement → compliance
4949
- Voting takes place on [Snapshot](https://snapshot.org/#/citizenshouse.eth) with EAS-verified Citizen identities
5050

51-
2. Veto Powers: Citizens have the ability to veto certain governance proposals approved by the Token House.
51+
2. Veto Powers: Citizens can veto certain governance proposals approved by the Token House.
5252

5353
| Proposal Type | Veto Threshold | Notes |
5454
|--------------|----------------|--------|
@@ -65,7 +65,7 @@ Guest voters are temporary Citizens selected for experimental rounds of Retro Fu
6565
- Enable reversibility in experiments
6666

6767
Inputs and outputs are measured via:
68-
- Surveys to voters and applicants
68+
- Surveys of voters and applicants
6969
- Voting behavior analysis
7070
- Social graph analysis
7171
- Reputation signals (contributions, usage, etc.)

sites/optimism/docs/governance/the-operating-manual/the-operating-manual.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ sidebar_label: The Operating Manual
66

77
# The Operating Manual (v0.4.2)
88

9-
In this section we will describe the current governance proposal process of the Collective. It will evolve over time. The authoritative version is maintained [here](https://github.com/ethereum-optimism/OPerating-manual/blob/main/manual.md) on GitHub.
9+
In this section, we will describe the current governance proposal process of the Collective. It will evolve. The authoritative version is maintained [here](https://github.com/ethereum-optimism/OPerating-manual/blob/main/manual.md) on GitHub.
1010

1111
## Bicameral Governance
1212

1313
The Collective is governed by two Houses:
1414
- **Token House** handles most formal governance processes: protocol upgrades, OP allocation, representative elections, and proposal approvals.
1515
- **Citizens’ House** governs the distribution of Retro Funding and can **veto** proposals like protocol upgrades and inflation changes to protect the Collective from plutocratic or short-sighted decisions.
1616

17-
They were designed to serve different roles, and to check and balance each other’s influence.
17+
They were designed to serve different roles and to check and balance each other’s influence.
1818

1919
| House | Who votes? | Main Responsibilities | Voting System | Veto Powers |
2020
|-------|------------|------------------------|----------------|--------------|
@@ -50,7 +50,7 @@ Most proposals follow a three-week cycle:
5050

5151
- Week 3: Voting
5252
- Voting lasts 7 days via Optimism Governance Portal (Token House) or Snapshot (Citizens’ House).
53-
- Snapshot of voting power is taken at the start of the voting period.
53+
- A snapshot of voting power is taken at the start of the voting period.
5454
- Quorum and approval thresholds depend on the Proposal Type.
5555

5656
## Veto Process
@@ -110,7 +110,7 @@ Experiments with Guest Voters are ongoing. The Citizen Attestation Schema tracks
110110

111111
![citizen-attestaion.png](img/citizens-attestation.png)
112112

113-
Experiments follow this principles:
113+
Experiments follow these principles:
114114
- Measurable inputs + outcomes
115115
- Short feedback cycles
116116
- Reversibility (e.g. guest voter rounds)

sites/optimism/docs/governance/the-operating-manual/the-token-house.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The Token House is responsible for voting on most governance proposals, includin
2424
- Governance procedures (elections, structure changes, ratifications)
2525
- Code of conduct violations or representative removals
2626

27-
The Token House also participates in veto power when applicableparticularly over certain Citizens’ House proposals.
27+
The Token House also participates in veto power when applicable, particularly over certain Citizens’ House proposals.
2828

2929
## Governance Mechanism
3030

@@ -54,13 +54,13 @@ Although the Token House formally approves proposals through on-chain voting, ex
5454
- Coordinating technical upgrades or disbursements
5555
- Communicating implementation status post-approval
5656

57-
The Foundation operates as a steward, and is expected to decentralize its role over time.
57+
The Foundation operates as a steward and is expected to decentralize its role over time.
5858

5959
## Constitutional Alignment
6060

6161
The Token House operates within the framework defined by the Working Constitution, which has the following principles:
6262

63-
- **Governance minimization**: when multiple options achieve the same outcome, choose the least complex
63+
- **Governance minimization**: When multiple options achieve the same outcome, choose the least complex
6464
- **Forkability and exit**: collective freedom must be protected
6565
- **Anti-plutocracy**: token-based governance must be balanced by human-centric governance (Citizens)
6666
- **Impact = Profit**: proposals should aim to reward meaningful contributions to the ecosystem

0 commit comments

Comments
 (0)