Skip to content
This repository has been archived by the owner on Nov 27, 2024. It is now read-only.

Commit

Permalink
docs: update token voting docs (#94)
Browse files Browse the repository at this point in the history
**Motivation:**

This PR fixes broken links in the token voting docs.

**Modifications:**

Updated links to point to the `llama-periphery` repo not `llama` repo.

**Result:**

The docs will properly link to other pages and display the token voting
diagram.
  • Loading branch information
AustinGreen authored Jan 11, 2024
1 parent cbf16f4 commit ff44c97
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ You can find installation instructions in the [Foundry docs](https://book.getfou

We use [just](https://github.com/casey/just) to save and run a few larger, more complex commands.
You can find installation instructions in the [just docs](https://just.systems/man/en/).
All commands can be listed by running `just -l` from the repo root, or by viewing the [`justfile`](https://github.com/llamaxyz/llama/blob/main/justfile).
All commands can be listed by running `just -l` from the repo root, or by viewing the [`justfile`](https://github.com/llamaxyz/llama-periphery/blob/main/justfile).

### VS Code

Expand Down Expand Up @@ -54,7 +54,7 @@ The comments in that file explain what each variable is for and when they're nee
### Deploy and Verify

- `just deploy` - deploy and verify payload on mainnet
- Run `just -l` or see the [`justfile`](https://github.com/llamaxyz/llama/blob/main/justfile) for other commands such as dry runs.
- Run `just -l` or see the [`justfile`](https://github.com/llamaxyz/llama-periphery/blob/main/justfile) for other commands such as dry runs.

## Testnet deployment

Expand All @@ -76,7 +76,7 @@ $ forge doc -o reference/ -b -s
```
## Bug bounty program

This repository is subject to the Llama bug bounty program. Details can be found [here](https://github.com/llamaxyz/llama/blob/main/README.md#bug-bounty-program).
This repository is subject to the [Llama bug bounty program](https://github.com/llamaxyz/llama/blob/main/README.md#bug-bounty-program).

## Slither

Expand Down
6 changes: 3 additions & 3 deletions docs/token-voting/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Llama Token Voting Module

![Llama Token Voting Module Overview](https://github.com/llamaxyz/llama/blob/main/diagrams/llama-token-voting-module-overview.png)
![Llama Token Voting Module Overview](https://github.com/llamaxyz/llama-periphery/blob/main/diagrams/llama-token-voting-module-overview.png)

The Llama token voting module allows governance token delegates to create actions and collectively cast approvals and disapprovals on an associated Llama instance. It follows established token voting framework best practices and is deployed through a dedicated factory contract.

Resources:

- [Token Voting Factory](https://github.com/llamaxyz/llama/blob/main/docs/token-voting/token-voting-factory.md)
- [Token Voting Module](https://github.com/llamaxyz/llama/blob/main/docs/token-voting/token-voting-module.md)
- [Token Voting Factory](https://github.com/llamaxyz/llama-periphery/blob/main/docs/token-voting/token-voting-factory.md)
- [Token Voting Module](https://github.com/llamaxyz/llama-periphery/blob/main/docs/token-voting/token-voting-module.md)
4 changes: 2 additions & 2 deletions docs/token-voting/token-voting-module.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Llama Token Voting Module

![Llama Token Voting Module Overview](https://github.com/llamaxyz/llama/blob/main/diagrams/llama-token-voting-module-overview.png)
![Llama Token Voting Module Overview](https://github.com/llamaxyz/llama-periphery/blob/main/diagrams/llama-token-voting-module-overview.png)

The Llama token voting module consists of a pair of smart contracts: a `LlamaTokenGovernor` and a token adapter.
It is deployed by the dedicated [token voting module factory](https://github.com/llamaxyz/llama/blob/main/docs/token-voting/token-voting-factory.md).
It is deployed by the dedicated [token voting module factory](https://github.com/llamaxyz/llama-periphery/blob/main/docs/token-voting/token-voting-factory.md).

Each token voting module is associated with a Llama instance and a governance token that is used to get past total supply and account voting balances.
The `LlamaTokenGovernor` contract uses the token adapter to standardize interactions with the governance token.
Expand Down

0 comments on commit ff44c97

Please sign in to comment.