Skip to content

Commit ca66d17

Browse files
bonustrackgitbook-bot
authored andcommitted
GITBOOK-500: change request with no subject merged in GitBook
1 parent 69dc782 commit ca66d17

22 files changed

+113
-167
lines changed

β€ŽREADME.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,26 @@ cover: .gitbook/assets/Snapshot_infra.jpg
33
coverY: 0
44
---
55

6-
# Welcome to Snapshot docs!
6+
# Welcome to Snapshot docs
77

8-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h2>What is Snapshot? ⚑️</h2></td><td></td><td></td><td><a href="introduction.md">introduction.md</a></td></tr><tr><td><h2>FAQ ❓</h2></td><td></td><td></td><td><a href="faq/">faq</a></td></tr></tbody></table>
8+
## What is Snapshot? <a href="#welcome-to-snapshot" id="welcome-to-snapshot"></a>
9+
10+
Snapshot is a **voting platform** that allows DAOs, DeFi protocols, or NFT communities to vote easily and **without gas fees**.The tool allows high customization of the voting process to cater to the diverse needs of the users and organizations. Customization includes different aspects like calculation of the users' voting power, selection of the voting mechanism, proposal and vote validation, and many more.In short, Snapshot is an off-chain gasless multi-governance client which results are easy to verify and hard to contest.
11+
12+
### Key features <a href="#key-features" id="key-features"></a>
13+
14+
* **Gasless:** Create proposals and cast your votes without any gas fees.
15+
* **Flexible voting strategies:** Customize how the voting power is calculated through single or combined strategies that enable voting with ERC20s, NFTs, other contracts, and more.
16+
* **Proposal and voting validation:** Use custom logic to define who can create a proposal or cast a vote.
17+
* **Multiple voting systems:** Single choice, approval voting, quadratic voting, and more.
18+
* **Signed messages:** Votes are cast through signed messages easily verifiable.
19+
* **Custom branding** - spaces can use their own branding, color schemes and domain name.
20+
* **Fully open-source:** Snapshot is fully open source with MIT license, the code is available on GitHub at [https://github.com/snapshot-labs](https://github.com/snapshot-labs/).​
21+
22+
## How does it work? <a href="#how-does-it-work" id="how-does-it-work"></a>
23+
24+
Snapshot’s protocol involves three core elements: spaces, proposals, and votes. A space functions like an organization’s profile, and every proposal and vote is tied to that space. To create a space, the only requirement is to have an ENS domain. Once a space is set up, users can submit proposals and cast their votes on the space’s page. Administrators of the space can tailor the rules for creating proposals and voting by configuring various voting and validation strategies. For instance, a space might require users to hold a minimum of 500 tokens to create a proposal, or it might assign voting power proportionally to the token balance in a user’s wallet.
925

1026
### What are you looking for?
1127

12-
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h2>User Guides</h2></td><td>I want to create a space, proposal or cast a vote.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><h2>Dev Guides</h2></td><td>I want to contribute to Snapshot.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><h2>Tools</h2></td><td>I want to integrate Snapshot's functionality in my own product.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
28+
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h2>User guides</h2></td><td>I want to create a space, proposal or cast a vote.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><h2>Dev guides</h2></td><td>I want to contribute to Snapshot.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr><tr><td><h2>Tools</h2></td><td>I want to integrate Snapshot's functionality in my own product.</td><td></td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>

β€ŽSUMMARY.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,6 @@
11
# Table of contents
22

3-
* [Welcome to Snapshot docs!](README.md)
4-
* [Introduction to Snapshot](introduction.md)
5-
* [Space handbook](space-handbook/README.md)
6-
* [Most common](space-handbook/most-common.md)
7-
* [Voting threshold](space-handbook/voting-threshold.md)
8-
* [Anti-whale](space-handbook/anti-whale.md)
9-
* [Sybil resistance, scam & spam prevention](space-handbook/sybil-resistance-scam-and-spam-prevention.md)
10-
* [Liquidity / staking pool](space-handbook/liquidity-staking-pool.md)
11-
* [Delegation](space-handbook/delegation.md)
12-
* [NFT voting](space-handbook/nft-voting/README.md)
13-
* [Most common: ERC-721](space-handbook/nft-voting/most-common-erc-721.md)
14-
* [Multi-token: ERC-1155](space-handbook/nft-voting/multi-token-erc-1155.md)
15-
* [POAP - Proof of Attendance](space-handbook/nft-voting/poap-proof-of-attendance.md)
16-
* [Custom calculations](space-handbook/custom-calculations.md)
3+
* [Welcome to Snapshot docs](README.md)
174
* [FAQs](faq/README.md)
185
* [πŸ‘‹ Getting started](faq/getting-started.md)
196
* [πŸ™Ž I'm a Snapshot user](faq/im-a-snapshot-user/README.md)
@@ -41,6 +28,18 @@
4128
* [Migrate or delete or a space](user-guides/spaces/migrate-or-delete.md)
4229
* [Space badges](user-guides/spaces/badges-and-warnings.md)
4330
* [Turbo plan](user-guides/spaces/turbo-plan.md)
31+
* [Space handbook](user-guides/spaces/space-handbook/README.md)
32+
* [Most common](user-guides/spaces/space-handbook/most-common.md)
33+
* [Voting threshold](user-guides/spaces/space-handbook/voting-threshold.md)
34+
* [Anti-whale](user-guides/spaces/space-handbook/anti-whale.md)
35+
* [Sybil resistance, scam & spam prevention](user-guides/spaces/space-handbook/sybil-resistance-scam-and-spam-prevention.md)
36+
* [Liquidity / staking pool](user-guides/spaces/space-handbook/liquidity-staking-pool.md)
37+
* [Delegation](user-guides/spaces/space-handbook/delegation.md)
38+
* [NFT voting](user-guides/spaces/space-handbook/nft-voting/README.md)
39+
* [Most common: ERC-721](user-guides/spaces/space-handbook/nft-voting/most-common-erc-721.md)
40+
* [Multi-token: ERC-1155](user-guides/spaces/space-handbook/nft-voting/multi-token-erc-1155.md)
41+
* [POAP - Proof of Attendance](user-guides/spaces/space-handbook/nft-voting/poap-proof-of-attendance.md)
42+
* [Custom calculations](user-guides/spaces/space-handbook/custom-calculations.md)
4443
* [Proposals](user-guides/proposals/README.md)
4544
* [Create a proposal](user-guides/proposals/create.md)
4645
* [Edit a proposal](user-guides/proposals/edit-a-proposal.md)
@@ -54,13 +53,10 @@
5453
* [Token verification](user-guides/token-verification.md)
5554
* [Using Safe multi-sig](user-guides/using-safe-multi-sig.md)
5655
* [Delegation](user-guides/delegation.md)
57-
* [Email notifications](user-guides/email-notifications.md)
58-
* [Mobile notifications](user-guides/mobile-notifications.md)
5956

6057
## Developer Guides
6158

6259
* [Add a network](developer-guides/networks.md)
63-
* [Create a plugin](developer-guides/create-a-plugin.md)
6460
* [Create a strategy](developer-guides/create-a-strategy/README.md)
6561
* [Create a voting strategy](developer-guides/create-a-strategy/voting-strategy.md)
6662
* [Create a validation strategy](developer-guides/create-a-strategy/validation-strategy.md)
@@ -74,6 +70,7 @@
7470
* [API Keys](tools/api/api-keys.md)
7571
* [Webhooks](tools/webhooks.md)
7672
* [Subgraphs](tools/subgraphs.md)
73+
* [Mobile notifications](tools/mobile-notifications.md)
7774
* [Bots](tools/bots.md)
7875

7976
## Snapshot X
@@ -103,14 +100,15 @@
103100

104101
## V1 interface
105102

103+
* [Email notifications](v1-interface/email-notifications.md)
106104
* [Plugins](v1-interface/plugins/README.md)
107105
* [What is a plugin?](v1-interface/plugins/what-is-a-plugin-and-how-to-use-it.md)
108-
* [SafeSnap: oSnap](v1-interface/plugins/safesnap-osnap.md)
109-
* [SafeSnap: Reality](v1-interface/plugins/safesnap-reality.md)
106+
* [Create a plugin](v1-interface/plugins/create-a-plugin.md)
107+
* [oSnap](v1-interface/plugins/safesnap-osnap.md)
108+
* [SafeSnap](v1-interface/plugins/safesnap-reality.md)
110109
* [POAP](v1-interface/plugins/poap.md)
111-
* [Comment Box](v1-interface/plugins/comment-box.md)
112110
* [Quorum](v1-interface/plugins/quorum.md)
113-
* [Domino Notifications](v1-interface/plugins/domino.md)
111+
* [Domino notifications](v1-interface/plugins/domino.md)
114112
* [Gnosis Impact (deprecated)](v1-interface/plugins/gnosis-impact.md)
115113
* [Galxe](v1-interface/plugins/galxe.md)
116114
* [Boost](v1-interface/boost.md)

β€Žintroduction.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

β€Žuser-guides/proposals/voting-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Voting type is defined in the space settings or at the level of an individual pr
1919
* Choose only **one option** - [#single-choice-voting](voting-types.md#single-choice-voting "mention")
2020
* Spread their votes over **multiple options** - [#weighted-voting](voting-types.md#weighted-voting "mention")
2121
* **Approve** a certain number of options - [#approval-voting](voting-types.md#approval-voting "mention")
22-
* Spread their votes over multiple options using the [**quadratic voting**](https://en.wikipedia.org/wiki/Quadratic\_voting) **formula** - [#quadratic-voting](voting-types.md#quadratic-voting "mention")
22+
* Spread their votes over multiple options using the [**quadratic voting**](https://en.wikipedia.org/wiki/Quadratic_voting) **formula** - [#quadratic-voting](voting-types.md#quadratic-voting "mention")
2323
* Rank the different choices in their **order of preference** - [#ranked-choice-voting-instant-runoff-voting](voting-types.md#ranked-choice-voting-instant-runoff-voting "mention")
2424
* **Abstain** from voting while still participating in quorum - [#basic-voting](voting-types.md#basic-voting "mention")
2525

@@ -124,7 +124,7 @@ All in all, you don't have to understand each step of the calculation. Yet, it s
124124
{% hint style="danger" %}
125125
This Voting type may encourage the whales to create multiple wallets and split their holdings among them. Therefore it's important to also implement a mechanism providing Sybil Resistance. \
126126
\
127-
**Read more** [**here**](../../space-handbook/sybil-resistance-scam-and-spam-prevention.md)**!**
127+
**Read more** [**here**](../spaces/space-handbook/sybil-resistance-scam-and-spam-prevention.md)**!**
128128
{% endhint %}
129129

130130
**Pros**: Dilutes the whales' voting power in favor of smaller holders. Individuals will matter more than the number of tokens. \

β€Žspace-handbook/README.md renamed to β€Žuser-guides/spaces/space-handbook/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ description: Find the best solution for your use case!
99
\
1010
Make sure to learn about those concepts before diving into this chapter! \
1111
\
12-
πŸ‘‰ [Voting strategies](../user-guides/strategies/voting-strategies.md)\
13-
πŸ‘‰ [Validation strategies](../user-guides/strategies/validation-strategies.md)\
14-
πŸ‘‰ [Voting t](../user-guides/proposals/voting-types.md)[ypes](../user-guides/proposals/voting-types.md)\
12+
πŸ‘‰ [Voting strategies](../../strategies/voting-strategies.md)\
13+
πŸ‘‰ [Validation strategies](../../strategies/validation-strategies.md)\
14+
πŸ‘‰ [Voting t](../../proposals/voting-types.md)[ypes](../../proposals/voting-types.md)\
1515
\
16-
We also recommend going through the entire [Spaces](../user-guides/spaces/) guide to get acquainted with the process of [creating a Space](../user-guides/spaces/create/) and updating its [settings](../user-guides/spaces/settings.md).
16+
We also recommend going through the entire [Spaces](../) guide to get acquainted with the process of [creating a Space](../create/) and updating its [settings](../settings.md).
1717
{% endhint %}
1818

1919
This section will help you **combine Voting types, Validation, and Voting strategies** based on your organization's needs. We will look into:
@@ -29,12 +29,12 @@ This section will help you **combine Voting types, Validation, and Voting strate
2929

3030
If none of the above are a good fit for your Space, we encourage you to use the **Search** feature of this documentation with the **Lens** option selected to ask a question and receive a human-friendly answer :wink:
3131

32-
<figure><img src="../.gitbook/assets/Screenshot 2023-05-23 at 12.48.02.png" alt=""><figcaption></figcaption></figure>
32+
<figure><img src="../../../.gitbook/assets/Screenshot 2023-05-23 at 12.48.02.png" alt=""><figcaption></figcaption></figure>
3333

3434
Feel free to reach out to us on [Discord](https://discord.com/channels/707079246388133940/1090290400943677440) to suggest use cases that we did not cover!
3535

36-
[^1]: Voting Strategies are used to calculated user's Voting Power. [Read more here](../user-guides/strategies/voting-strategies.md).
36+
[^1]: Voting Strategies are used to calculated user's Voting Power. [Read more here](../../strategies/voting-strategies.md).
3737

38-
[^2]: Validation Strategies are used to define if a user is eligible to vote or create a proposal. [Read more here](../user-guides/strategies/validation-strategies.md).
38+
[^2]: Validation Strategies are used to define if a user is eligible to vote or create a proposal. [Read more here](../../strategies/validation-strategies.md).
3939

40-
[^3]: Voting Systems relate to how users can cast their votes and how the final results of a proposal is calculated. [Read more here.](../user-guides/proposals/voting-types.md)
40+
[^3]: Voting Systems relate to how users can cast their votes and how the final results of a proposal is calculated. [Read more here.](../../proposals/voting-types.md)

0 commit comments

Comments
Β (0)