Skip to content

Commit

Permalink
Improved readme with diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
brickpop committed Jan 24, 2024
1 parent 30d0e79 commit 09f504a
Show file tree
Hide file tree
Showing 9 changed files with 265 additions and 9 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ packages/subgraph/deploy-output.txt
packages/subgraph/subgraph.yaml
packages/subgraph/tests/.latest.json
packages/subgraph/tests/helpers/extended-schema.ts

*.bkp
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,34 @@ The current repository provides the plugins necessary to cover two use cases:
- Space plugin
- Personal Space Admin plugin

### Standard Space

In standard spaces, _members_ can create proposals while _editors_ can vote whether they should pass. Proposals eventually approved can be executed by anyone and this will make the DAO call the predefined proposal actions.

The most typical case will be telling the Space Plugin to emit the event of a proposal being processed.

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

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

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

To add new members, the Member Access Plugin allows anyone to request the permission. Editors can approve or reject it.

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

### Personal Space

Personal spaces are a simplified version, where anyone defined as editor can immediatelly execute proposals. Typically to edit the contents of a space.

<img src="./img/personal-1.svg">

### Plugin Upgrader

There's an optional case, where a predefined address can execute the actions to upgrade a plugin to the latest published version.

<img src="./img/upgrader-1.svg">

## Global lifecycle

### Space genesis
Expand Down
206 changes: 206 additions & 0 deletions img/Geo Diagrams.drawio

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions 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.
Loading

0 comments on commit 09f504a

Please sign in to comment.