Skip to content

Commit

Permalink
Added new How to... section.
Browse files Browse the repository at this point in the history
  • Loading branch information
NoahSaso committed Jan 15, 2024
1 parent 1518499 commit bd8a1a7
Show file tree
Hide file tree
Showing 22 changed files with 152 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Configuration",
"position": 4
"position": 5
}
2 changes: 1 addition & 1 deletion docs/features/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Features",
"position": 3
"position": 4
}
6 changes: 3 additions & 3 deletions docs/features/proposals/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ proposal](/img/features/proposals/multiple-choice-proposal-done.png)

If you create a new DAO, multiple choice proposals are enabled by default. If
you have an existing DAO without multiple choice proposals enabled, you can
enable them by [passing a single choice proposal](/quickstart/create-a-proposal)
containing the `Enable Multiple Choice Proposals` action in the `DAO Governance`
category.
enable them by [passing a single choice
proposal](/how-to/how-to-create-a-proposal) containing the `Enable Multiple
Choice Proposals` action in the `DAO Governance` category.

On the proposal creation page, click the `Add an action` button.

Expand Down
4 changes: 2 additions & 2 deletions docs/features/proposals/what.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ moment the proposal goes live.

## How do I create a proposal?

Check out the [Create your first proposal](/quickstart/create-a-proposal) guide
in the Quickstart section to get started.
Check out the [How to create a proposal](/how-to/how-to-create-a-proposal) guide
to get started.
4 changes: 4 additions & 0 deletions docs/how-to/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "How to...",
"position": 3
}
48 changes: 48 additions & 0 deletions docs/how-to/how-to-create-a-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
sidebar_position: 1
---

# How to create a proposal

If you don't know what a proposal is, read the [proposal explanation
doc](/features/proposals/what) first.

:::note

Members must join the DAO before a proposal is made in order to vote on it.
Membership changes during a proposal's voting period are ignored as they only
apply to future proposals.

:::

## Steps

To begin, starting from your DAO's page, navigate to **Proposals > New
Proposal**.

![Create proposal button](/img/how-to/proposals-tab.png)

![Proposal creation form](/img/how-to/create-proposal.png)

Then, fill in the proposal's name, description, and actions (if needed).

:::tip What is an action?

[Proposal actions](/features/proposals/what#actions) allow you to add rich
functionality to proposals: software instructions that execute on the blockchain
when a proposal is passed and executed. Read the [proposal
docs](/features/proposals/what) to learn more.

:::

If you want to create a multiple choice proposal, check out the [multiple choice
proposal docs](/features/proposals/types#multiple-choice).

To preview how the proposal will look once its created, press **Preview**.

Once you are satisfied with the proposal, press **Publish**. Your wallet will
prompt you to approve the transaction.

Once you approve it, your proposal will be live and the DAO members can vote on it!

![Created proposal](/img/quickstart/create-proposal-done.png)
57 changes: 57 additions & 0 deletions docs/how-to/how-to-send-tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
sidebar_position: 3
---

# How to send tokens

Sending tokens from a DAO is easy. Tokens can be sent to a recipient on the same
chain as the DAO or on another
[IBC](/introduction/whats-a-blockchain#how-do-you-send-tokens-between-blockchains)-connected
chain.

## Steps

[Create a proposal](/how-to/how-to-create-a-proposal) and add the `Spend` action
from the `DAO Treasury` category.

![Create proposal form](/img/features/proposals/single-choice-proposal.png)

![DAO Treasury category in Add an action
modal](/img/how-to/add-action-modal-dao-treasury-category.png)

![Spend action in DAO Treasury
category](/img/how-to/spend-action-dao-treasury-category.png)

![Spend action](/img/how-to/spend-action.png)

### Change recipient chain

To choose which chain the tokens should be sent to, click on the dropdown to the
left of the recipient address. This can be the same chain as the DAO or any
IBC-connected chain.

![Spend action recipient chain](/img/how-to/spend-action-recipient-chain.png)

Simply choose which chain to send the tokens to.

![Chain picker](/img/how-to/chain-picker.png)

:::tip

Only chains that have an active IBC connection with the chain the DAO lives on
can be chosen. All chains shown in the list should work, but it's always a good
idea to double check with someone if you are unsure. If there is a chain missing
from the list, or a chain does not appear to work, please reach out to the
developers on [Discord](https://discord.daodao.zone).

:::

Once choosing a chain, it will confirm the IBC path the tokens will be sent
through.

![Spend action with IBC path](/img/how-to/spend-action-ibc.png)

For example, the action above will send 1 $JUNO from the DAO's Juno treasury to
a wallet on Osmosis.

Once this proposal is passed and executed, the tokens will be sent.
32 changes: 32 additions & 0 deletions docs/how-to/how-to-vote-on-a-proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 2
---

# How to vote on a proposal

Once you've [created a proposal](/how-to/how-to-create-a-proposal), members of
the DAO need to vote on it.

## Steps

To begin, starting from your DAO's page, navigate to the proposal from the
**Proposals** tab.

![Proposals tab](/img/how-to/proposals-tab-with-proposals.png)

Then, click on the proposal you want to vote on in the list.

![Proposal page](/img/how-to/proposal-no-votes.png)

Click on the desired vote option on the left side of the page.

![Vote options](/img/how-to/single-choice-proposal-vote-options.png)

Click on the **Cast your vote** button to submit your vote. Approve the
transaction in your wallet to confirm submission.

![Proposal still open](/img/how-to/open-proposal-already-voted.png)

The proposal will be updated with your vote. If your vote was sufficient to pass
or fail the proposal, it will now be complete. Since this proposal's outcome has
not yet been determined, it is still open for voting.
2 changes: 2 additions & 0 deletions docs/introduction/whats-a-blockchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ Before IBC, each blockchain was siloed. There was no way to send a token from
one self-sovereign blockchain to another. IBC allows chains to share data with
one another, including tokens.

You can dive deeper into IBC from [its website](https://www.ibcprotocol.dev/).

:::tip

Since DAO DAO is IBC-native, your DAO's governance tokens can be shared across
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart/joining-leaving-member-based-dao.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ DAOs have static membership, meaning the DAO must pass a proposal to add or
remove members. Members cannot independently decide to join or leave a
member-based DAO.

You may want to read the [proposal creation
guide](/quickstart/create-a-proposal) to understand how proposals work in DAOs
You may want to read the [proposal explanation
doc](/features/proposals/what) to understand how proposals work in DAOs
before proceeding.

## Joining (adding)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/chain-picker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/create-proposal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/proposal-no-votes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/proposals-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/spend-action-ibc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/how-to/spend-action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd8a1a7

Please sign in to comment.