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

About voting to change community visibility #692

Conversation

cheny0
Copy link
Contributor

@cheny0 cheny0 commented Jul 12, 2023

  • Ready for review
  • Update the title

@cheny0 cheny0 added doc-new Additions to the Status documentation E:Communities Status Communities labels Jul 12, 2023
@cheny0 cheny0 self-assigned this Jul 12, 2023
@cheny0 cheny0 requested a review from osmaczko July 12, 2023 03:26
@cheny0
Copy link
Contributor Author

cheny0 commented Jul 12, 2023

Hi Patryk @osmaczko, this document introduces the voting mechanism. The steps users need to follow are in the other document.

@cheny0 cheny0 requested a review from jorge-campo August 2, 2023 15:35
Copy link
Contributor

@jorge-campo jorge-campo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your work on this not-so-easy article, @cheny0!

Here are some suggestions to improve your content:

Title

Your title is missing an article. I verified this point with Bing Chat, and it's better to use 'About voting to change the community visibiliy'. Don't forget to rename the Markdown file as well.

Intro

I suggest some changes in the first paragraph. Avoid using filler words like 'engage' and passive forms.

'All SNT holders can vote whether to include, exclude, or feature a Status Community on the Communities Discover page within the Status app. Only voters decide the outcome of the vote, and Status has no control over the voting results.'

After this first paragraph, we need a screenshot with the "Discover" screen. Otherwise, it might be challenging for the reader to understand what we're discussing. Alternatively, you can add the screenshot as the header of the article. It doesn't matter if it's the same header you used in another article, as long as it's clear what we're talking about.

The basics

  • You don't spend the tokens to vote, but you must hold the tokens during the validation and finalization periods, or your vote is discarded.

    • 'Discarded' has a somewhat negative connotation. Whenever you mention something negative, try to make it sound positive. The only exception to this 'rule' is when you discuss security-related things or things that can result in loss of funds.
    • An SNT is a token, correct, but it's a particular type of token. It's an asset.
    • I suggest something like, 'You don't spend or lose control over the assets when you vote, but you must hold the assets during the validation and finalization periods for your vote to count.
  • 'The amount of gas fee depends on the traffic of Optimism' -> 'The amount of gas fee depends on the traffic of the Optimism network' and link 'Optimism network' to the 'Layer-2 scaling solutions for Ethereum' article.

Voting to make a community public or private

  • 'When a community is created, it's a private community by default'. In 'private community', link to the different types of Status Communities article.

  • There is something I don't understand, and that may be the case for the reader as well. You say, 'If no one verifies the vote, only the initial vote is counted', and then you say, 'After verification, the vote must be finalized.'

    • Your first sentence seems to imply that it's possible that no one verifies the vote (by 'vote' I assume you mean all the votes?), but then you say that after verification, the vote must be finalized. So, it isn't clear to me if verification is mandatory; or what happens if no one verifies the vote; is the verification automatically closed somehow? (or something else). Let me know if this makes sense or if you prefer to discuss this on a call.

Voting to feature a community

  • In the same way, you explain in the previous section what happens with private a public communities, you need to explain here what it means to 'feature' a community. Actually, you have that sentence in the second paragraph, 'The top five communities in the number of SNT tokens appear in the Featured section, replacing the communities that were featured previously.'

  • ' If no one verifies the vote, only the first vote of this round is counted.' I have the same problem with this sentence described in the previous section. Is verification 'mandatory'? What happens if no one verifies the vote?

  • 'The Feature this community button next to the name of this community is greyed out' -> 'The Feature this community button next to the name of this community is greyed out and disabled'.

About finalizing a vote

  • 'Otherwise, the vote remains pending.' -> 'Otherwise, the vote remains pending and no more votes can occur.'

  • It's worth highlighting again, using a note-style admonition, the fact that 'The top five communities in the number of SNT tokens appear in the Featured section'. Users should not assume that just because the vote is favorable to featuring the community, it will be featured.

Note

On each one of your H2s, I miss a link to the article where you explain how to do these things. You have two procedure-type articles that you can link at the end of every H2 section. Even when this may look repetitive, it's a good repetition because it helps the reader understand the real process.

@cheny0
Copy link
Contributor Author

cheny0 commented Aug 10, 2023

Hi @jorge-campo, I have edited the document based on your comments and our discussion. Thanks!

@cheny0 cheny0 closed this Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-new Additions to the Status documentation E:Communities Status Communities
Projects
Status: Published/Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants