Skip to content

Commit a607d5a

Browse files
samuvethgitbook-bot
authored andcommitted
GITBOOK-378: Docs front page
1 parent ff41f9d commit a607d5a

File tree

4 files changed

+69
-55
lines changed

4 files changed

+69
-55
lines changed

.gitbook/assets/Snapshot_infra.jpg

714 KB
Loading

README (1).md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
description: >-
3+
This page intends to give you a brief explanation of what Snapshot is and how
4+
it works. It also provides you with all the necessary information to get
5+
started.
6+
---
7+
8+
# Home
9+
10+
## Welcome to Snapshot!
11+
12+
Snapshot is a **voting platform** that allows DAOs, DeFi protocols, or NFT communities to vote easily and **without gas fees**. 
13+
14+
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.
15+
16+
In short, Snapshot is an off-chain gasless multi-governance client which results are easy to verify and hard to contest.
17+
18+
### Key features
19+
20+
* **Free** **usage** - create spaces, proposals and take part in organization's governance without any gas fees
21+
* **Signed messages** - votes are cast through signed messages easily verifiable online
22+
* **Multiple voting systems** - Single choice, Approval voting, Quadratic voting, and more
23+
* **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
24+
* **Proposal and voting validation** - utilize Gitcoin Passport, POAPs or other solutions to validate who can create a proposal or cast a vote
25+
* **Custom branding** - spaces can use their own branding, color schemes and domain name
26+
* **Fully open-source** with MIT license - our code can be viewed on Github at [https://github.com/snapshot-labs/](https://github.com/snapshot-labs/)
27+
28+
### How does it work?
29+
30+
There are three key elements that are involved in the voting process: **spaces**, **proposals** and **votes**. Proposals and votes are associated with a space, while each space is an account (profile) of an organization. 
31+
32+
You will need an **ENS domain** in order to create a space on Snapshot, which is also the only requirement from Snapshot's side to set up a space.
33+
34+
Users can then create proposals for the space and vote on them. Space admins can define the **rules** for proposal creation and casting a vote by setting up voting and validation strategies. For example only users holding a minimum of 10K of specified token can create a new proposal and the voting power of users is proportional to the balance of the specified token in their wallet.
35+
36+
For more details about the voting process and customization have a look at the detailed pages of our documentation.
37+
38+
### Where to start?
39+
40+
This guide is meant for all existing and future Snapshot users. Therefore regardless whether you are new to Web3, want to create a Space for your organization or are a contributor working on custom voting strategies, you will be able to find resources for your own use case within our documentation.
41+
42+
<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><h3><strong>Spaces</strong></h3></td><td>I want to manage my organization's account on Snapshot.</td><td></td><td><a href="user-guides/spaces/">spaces</a></td></tr><tr><td><h3>Proposals</h3></td><td>I want to create a proposal.</td><td></td><td><a href="user-guides/proposals/">proposals</a></td></tr><tr><td><h3>Voting</h3></td><td>I want to vote on a proposal.</td><td></td><td></td></tr><tr><td><h3>Contribute</h3></td><td>I want to create a new strategy, a plugin or contribute to the codebase.</td><td></td><td><a href="developer-guides/contribute/">contribute</a></td></tr><tr><td><h3>Tools</h3></td><td>I want to integrate Snapshot in my product, use API or get notifications about new proposals.</td><td></td><td><a href="tools/tools-overview.md">tools-overview.md</a></td></tr></tbody></table>
43+
44+
If you don't know where to start or have a specific question, head to the FAQ section!
45+
46+
{% content-ref url="faq.md" %}
47+
[faq.md](faq.md)
48+
{% endcontent-ref %}
49+
50+
### Contributing
51+
52+
We want to create a product which is easy to use by anyone - technical and non-technical, Web3-native or completely new to the space.&#x20;
53+
54+
As open-source mindset and community are at the heart of Snapshot we are inviting you to contribute with general feedback, code, code review, design, bug reports, advice, documentation, or anything else you can think of.
55+
56+
Head to [#contributing](<README (1).md#contributing> "mention") to learn how you can help us enhance Snapshot!
57+
58+
### **What’s next?**
59+
60+
The next part of the guide will take you through the steps of **creating a space on Snapshot**. It will also take you through the process of registering an ENS domain if you do not have one already.&#x20;

README.md

Lines changed: 7 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,13 @@
11
---
2-
description: >-
3-
This page intends to give you a brief explanation of what Snapshot is and how
4-
it works. It also provides you with all the necessary information to get
5-
started.
2+
cover: .gitbook/assets/Snapshot_infra.jpg
3+
coverY: 0
4+
layout: landing
65
---
76

8-
# Home
7+
# Welcome to Snapshot docs!
98

10-
## Welcome to Snapshot!
9+
<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="README (1).md">README (1).md</a></td></tr><tr><td><h2>FAQ ❓</h2></td><td></td><td></td><td><a href="faq.md">faq.md</a></td></tr></tbody></table>
1110

12-
Snapshot is a **voting platform** that allows DAOs, DeFi protocols, or NFT communities to vote easily and **without gas fees**.&#x20;
11+
### What are you looking for?
1312

14-
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.
15-
16-
In short, Snapshot is an off-chain gasless multi-governance client which results are easy to verify and hard to contest.
17-
18-
### Key features
19-
20-
* **Free** **usage** - create spaces, proposals and take part in organization's governance without any gas fees
21-
* **Signed messages** - votes are cast through signed messages easily verifiable online
22-
* **Multiple voting systems** - Single choice, Approval voting, Quadratic voting, and more
23-
* **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
24-
* **Proposal and voting validation** - utilize Gitcoin Passport, POAPs or other solutions to validate who can create a proposal or cast a vote
25-
* **Custom branding** - spaces can use their own branding, color schemes and domain name
26-
* **Fully open-source** with MIT license - our code can be viewed on Github at [https://github.com/snapshot-labs/](https://github.com/snapshot-labs/)
27-
28-
### How does it work?
29-
30-
There are three key elements that are involved in the voting process: **spaces**, **proposals** and **votes**. Proposals and votes are associated with a space, while each space is an account (profile) of an organization.&#x20;
31-
32-
You will need an **ENS domain** in order to create a space on Snapshot, which is also the only requirement from Snapshot's side to set up a space.
33-
34-
Users can then create proposals for the space and vote on them. Space admins can define the **rules** for proposal creation and casting a vote by setting up voting and validation strategies. For example only users holding a minimum of 10K of specified token can create a new proposal and the voting power of users is proportional to the balance of the specified token in their wallet.
35-
36-
For more details about the voting process and customization have a look at the detailed pages of our documentation.
37-
38-
### Where to start?
39-
40-
This guide is meant for all existing and future Snapshot users. Therefore regardless whether you are new to Web3, want to create a Space for your organization or are a contributor working on custom voting strategies, you will be able to find resources for your own use case within our documentation.
41-
42-
<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><h3><strong>Spaces</strong></h3></td><td>I want to manage my organization's account on Snapshot.</td><td></td><td><a href="user-guides/spaces/">spaces</a></td></tr><tr><td><h3>Proposals</h3></td><td>I want to create a proposal.</td><td></td><td><a href="user-guides/proposals/">proposals</a></td></tr><tr><td><h3>Voting</h3></td><td>I want to vote on a proposal.</td><td></td><td></td></tr><tr><td><h3>Contribute</h3></td><td>I want to create a new strategy, a plugin or contribute to the codebase.</td><td></td><td><a href="developer-guides/contribute/">contribute</a></td></tr><tr><td><h3>Tools</h3></td><td>I want to integrate Snapshot in my product, use API or get notifications about new proposals.</td><td></td><td><a href="tools/tools-overview.md">tools-overview.md</a></td></tr></tbody></table>
43-
44-
If you don't know where to start or have a specific question, head to the FAQ section!
45-
46-
{% content-ref url="faq.md" %}
47-
[faq.md](faq.md)
48-
{% endcontent-ref %}
49-
50-
### Contributing
51-
52-
We want to create a product which is easy to use by anyone - technical and non-technical, Web3-native or completely new to the space.&#x20;
53-
54-
As open-source mindset and community are at the heart of Snapshot we are inviting you to contribute with general feedback, code, code review, design, bug reports, advice, documentation, or anything else you can think of.
55-
56-
Head to [#contributing](./#contributing "mention") to learn how you can help us enhance Snapshot!
57-
58-
### **What’s next?**
59-
60-
The next part of the guide will take you through the steps of **creating a space on Snapshot**. It will also take you through the process of registering an ENS domain if you do not have one already.&#x20;
13+
<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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Table of contents
22

3-
* [Home](README.md)
3+
* [Welcome to Snapshot docs!](README.md)
4+
* [Home](<README (1).md>)
45
* [FAQs](faq.md)
56

67
## User guides

0 commit comments

Comments
 (0)