Skip to content

Commit

Permalink
Merge pull request #15 from aragon/f/updated-readme
Browse files Browse the repository at this point in the history
Updated readme
  • Loading branch information
brickpop authored Jun 10, 2024
2 parents a7adec1 + 666c648 commit 0469203
Show file tree
Hide file tree
Showing 14 changed files with 314 additions and 82 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,15 @@ In standard spaces, _members_ can create proposals while _editors_ can vote on t

The most typical case will be telling the Space Plugin to emit the event of a proposal being processed. It can include emitting a new hash for the contents or accepting a subspace.

<img src="./img/std-1.svg">
<img src="./img/standard-1.svg">

The Main Voting Plugin can also pass proposals that change its own settings.

<img src="./img/std-2.svg">
<img src="./img/standard-2.svg">

To manage who can create proposals, the Member Access Plugin allows anyone to request becoming a member. Editors can approve or reject incoming proposals.

<img src="./img/std-3.svg">
<img src="./img/standard-3.svg">

### Personal Space

Expand All @@ -75,8 +75,9 @@ There's an optional feature, where a predefined address can execute the actions

### Joining a space

1. Someone calls `proposeNewMember()` on the `MemberAccessPlugin`
1. Someone calls `proposeAddMember()` on the `MainVotingPlugin`
- If the caller is the only editor, the proposal succeeds immediately
- The proposal is created on the `MemberAccessPlugin` because the governance rules differ from the rest of proposals
2. One of the editors calls `approve()` or `reject()`
- Calling `approve()` makes the proposal succeed
- Calling `reject()` cancels the proposal
Expand Down Expand Up @@ -148,6 +149,12 @@ See the `MemberAccessExecuteCondition` contract. It restricts what the [MemberAc

### Permissions being used

For standard governance spaces:
<img src="./img/permission-overview-std.svg">

For personal spaces:
<img src="./img/permission-overview-personal.svg">

Below are all the permissions that a [PluginSetup](#plugin-setup-contracts) contract may want to request:

Proposal:
Expand Down
346 changes: 283 additions & 63 deletions img/Geo Diagrams.drawio

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions img/permission-overview-personal.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions img/permission-overview-std.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion img/personal-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion img/personal-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 0469203

Please sign in to comment.