Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(Test PR) Added FAQ pages and Items for review #7

Draft
wants to merge 21 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .gitbook/assets/add-a-plugin.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/image (1) (1) (1) (1).png
Binary file not shown.
Binary file removed .gitbook/assets/image (1) (1) (1).png
Binary file not shown.
Binary file removed .gitbook/assets/image (3) (1).png
Binary file not shown.
Binary file removed .gitbook/assets/image (3).png
Binary file not shown.
Binary file removed .gitbook/assets/image (4).png
Binary file not shown.
Binary file removed .gitbook/assets/image (5).png
Binary file not shown.
Binary file removed .gitbook/assets/image (6) (1) (1).png
Binary file not shown.
Binary file not shown.
Binary file removed .gitbook/assets/screenshot-164-.png
Binary file not shown.
Binary file removed .gitbook/assets/set-space-filters.png
Binary file not shown.
Binary file removed .gitbook/assets/snapshot.gif
Binary file not shown.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This page is intended to give you a brief explanation of what Snapshot is and ho

### **Introduction**

Snapshot is a decentralized voting system. It provides flexibility on how voting power is calculated for vote. Snapshot supports various voting types to cater to the needs of organizations. Creating proposals and voting on Snapshot is user friendly and does not cost any gas as the process is performed off-chain. In short, Snapshot is an off-chain gasless multi-governance client with easy to verify and hard to contest results. ****
Snapshot is a decentralized voting system. It provides flexibility on how voting power is calculated for vote. Snapshot supports various voting types to cater to the needs of organizations. Creating proposals and voting on Snapshot is user friendly and does not cost any gas as the process is performed off-chain. In short, Snapshot is an off-chain gasless multi-governance client with easy to verify and hard to contest results. _\*\*_

### **Key features**

Expand All @@ -25,7 +25,7 @@ Snapshot is a decentralized voting system. It provides flexibility on how voting

### **What’s next?**

Our next 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. Before you start creating a space, you might want to look into some spaces already created on Snapshot.
Our next 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. Before you start creating a space, you might want to look into some spaces already created on Snapshot.

> _We have limited resources so feel free to contribute with code, code review, design, bug reports, advices, documentation, or anything else you are good at._

14 changes: 13 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,19 @@
* [GraphQL API](graphql-api.md)
* [Webhooks](webhooks.md)
* [Snapshot.js](snapshot.js.md)
* [FAQs](faq.md)
* [FAQs](faq/README.md)
* [Spaces](faq/spaces.md)
* [Proposals](faq/proposals.md)
* [Votes](faq/votes.md)
* [Strategies](faq/strategies.md)
* [Delegation](faq/delegation.md)
* [Plugins](faq/plugins.md)
* [Networks](faq/networks.md)
* [Contribution](faq/contribution.md)
* [Integration](faq/integration.md)
* [GraphQL API](faq/graphql-api.md)
* [Webhooks](faq/webhooks.md)
* [Snapshot.js](faq/snapshot.js.md)

## Guides

Expand Down
46 changes: 0 additions & 46 deletions faq.md

This file was deleted.

144 changes: 144 additions & 0 deletions faq/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
description: Use the categories on the right sidebar or search through the entire FAQ.
---

# FAQs

## Spaces <a id="spaces"></a>

### How can I access my space or the demo space on snapshot?

Snapshot live: `http://snapshot.org/#/<SPACE ENS ADDRESS>`
Snapshot demo: `http://demo.snapshot.org/#/<SPACE ENS ADDRESS>`



### How can I get my space showing on the Snapshot homepage?

If you already have a space with GitHub see how to Migrate your space to ENS.

{% page-ref page="../spaces/migrate.md" %}

If you want to create a new space with ENS

{% page-ref page="../spaces/create.md" %}



### **What's the difference between admin and authors**

* `Admins` can edit `space settings`
* `Authors` can post `proposals`



## Proposals <a id="proposals"></a>

### Can I edit a proposal once I posted it ?

Nope, you can delete it and make a new one. You can also duplicate it, that will prefill all the fields.



### Why I can't save my proposal ?

* Make sure you filled "Question" and "What is you proposal" placeholders.
* Make sure you've added at least two choices.
* Make sure you've selected a set of actions for voting system, start and end date.
* Make sure to enter a "snapshot block number"

If you still cant's save your proposal contact us on [Discord](http://discord.snapshot.org) or [Telegram](https://t.me/snapshotlabs)



### Can I create different types of proposals like "core" and "community"?

If a proposal is created by an `Author` \(added in `space settings`\) it will be shown as `core` proposal.
All other proposal are community proposals.



## Votes

### **Why I can't vote?**

To be able to vote you need voting power, your voting power is calculated at the "snapshot" of the proposal. The snapshot is the block number where we read the voting power from. If you didn't have the tokens at this block number, you will not have any voting power and won't be able to vote.



### **I am getting an error "wrong timestamp", what is the problem?**

Most likely the issue is that your computer time is not synchronized with the internet time. This is how to fix this:

**On MacOS**
On your Mac, choose Apple menu &gt; System Preferences, then click Date & Time.
Click Date & Time, then set the date and time automatically.

[![MacOS](https://user-images.githubusercontent.com/55286013/135220574-a1c1ff59-e12a-4ba1-b234-6ebed9140f69.png)](https://user-images.githubusercontent.com/55286013/135220574-a1c1ff59-e12a-4ba1-b234-6ebed9140f69.png)

**On Windows**
Go to Start &gt; Settings &gt; Time & language &gt; Date & time.
Then set time automatically

[![Windows](https://user-images.githubusercontent.com/55286013/135220660-b6384c2d-a247-44af-ad06-b5429633a74e.png)](https://user-images.githubusercontent.com/55286013/135220660-b6384c2d-a247-44af-ad06-b5429633a74e.png)



## Strategies

### What strategy should I use for my proposal

It widely depends on your use case, if you want coin-voting \(1 token= 1 vote\) you can use "erc20-balance-of", however you may want:

* Delegate voting power using a delegation strategy
* Weighting voting power using a quadratic strategy
* NFT voting with an ERC-721 based strategy
* Only allow certain members to vote using whitelist strategy
* Calculate voting power from multiple chains with multichain strategy

You can combine up to 5 strategies on a single proposal \(combination work as OR not AND opperator\)

At the time of writing snapshot has over 150 voting strategies.
Explore them here [https://snapshot.org/\#/strategies](https://snapshot.org/#/strategies)
You can even preview actions using the playground button.



### I have updated my strategy, when the changes will take effect ?

Your changes will only affect future proposals, already existing proposals can not be edited.



### May I use multiple chains / networks strategies in my proposals ?

Yes you can use multi-chain strategy in your space, which can calculate voting power from multiple networks. Check this out: [https://snapshot.org/\#/strategy/multichain](https://snapshot.org/#/strategy/multichain)



### What is the decimal parameter ?

* When you create a token you have to define the number of decimal that you want
* Most of the token use 18 decimals
* To find out how many decimals your token has you can search the contract address on etherscan.io



### What is the address parameter ?

In order to setup a coin-voting strategy i.e. `erc20-balance-of` you need to change the placeholder address to your own token contract address.

## Delegation

## Networks

## Contribution

## API





{% page-ref page="spaces.md" %}

10 changes: 10 additions & 0 deletions faq/contribution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contribution

## **I pushed my PR, when do you check it and what time it will be live?**

Usually snapshot checks and follows through PRs every 24 to 48h, if you submitted yours and snapshot did not get back to you within this time limit, please chat with us on [**Discord**](https://discord.gg/dDbNGZe) or [**Telegram**](https://t.me/snapshotlabs)**.**

##



28 changes: 28 additions & 0 deletions faq/delegation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Delegation

## **When I added delegation, it appears to not allow anyone to vote.**

Delegation strategy syntax example:

```text
{
"symbol": "Shark",
"strategies": [
{
"name": "erc20-balance-of",
"params": {
"address": "0x232a...",
"symbol": "Shark",
"decimals": 18
}
}
]
}
```

if you pass something like this, it will calculate balance of this token 0x232a... that delegated to an address

##



10 changes: 10 additions & 0 deletions faq/graphql-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# GraphQL API

## I want to get all the voters from a space Is there any easy way to do this?

There is an API endpoint to get the list of all voters per space\(s\) and period see the last one, "List voters" [https://docs.snapshot.page/hub-api\#get-a-proposal](https://docs.snapshot.page/hub-api#get-a-proposal)





2 changes: 2 additions & 0 deletions faq/integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Integration

12 changes: 12 additions & 0 deletions faq/networks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Networks

## Can I use ENS domain on testnet ?

The ENS domain must be on mainnet, then on Snapshot settings page you can use any network for your space

## Can I use snapshot on non-EVM chains like Solana ?

Currently, Snapshot only support EVM chains, if you are looking to use it with Solana look at Neon cross-chain EVM.



12 changes: 12 additions & 0 deletions faq/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Plugins

## Can I become who I want to be?

That's a tough question but thankfully, our team is on it. Please bear with us while we're investigating.

## Have you had a chance to answer the previous question?

Yes, after a few months we finally found the answer. Sadly, Mike is on vacations right now so I'm afraid we are not able to provide the answer at this point.



20 changes: 20 additions & 0 deletions faq/proposals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Proposals

## Can I edit a proposal once I posted it ?

No, you can only delete it and make a new one.

## Why I can't save my proposal ?

* Make sure you filled "Question" and "What is you proposal" placeholders.
* Make sure you've added at least two choices.
* Make sure you've selected a set of actions for voting system, start and end date.

If you still cant's save your proposal contact us on Discord or Telegram

## Can I create different types of proposals like "core" and "community"?

If the proposal is created by a member \(added from settings\) it will be shown as `core` all other are community.



2 changes: 2 additions & 0 deletions faq/snapshot.js.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Snapshot.js

27 changes: 27 additions & 0 deletions faq/spaces.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Spaces

## **How can I access my space or the demo space on snapshot?**

* Snapshot live: `http://snapshot.page/#/<MY SPACE>`
* Snapshot demo: `http://demo.snapshot.page/#/<MY SPACE>`

## **How can I get my space showing on the Snapshot homepage?**

{% page-ref page="../spaces/create.md" %}

## **I went to** `https://snapshot.page/#/<MY SPACE>` **but I see a blank page?**

* Make sure you are connected with Metamask on the ETH mainnet.
* Try with Chrome or Firefox browser.

## **I can't save my space settings**

* Make sure you have filled all the required fields.
* If "Terms" field is required make sure the format is `http://<terms URL>` or `https://<terms URL>`



## **What's the difference between admin and authors**

Admin can edit space settings, authors can post proposals.

Loading