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

Update Voting Tutorial #376

Open
joshuahannan opened this issue Feb 15, 2021 · 5 comments · May be fixed by onflow/flow-playground-tutorials#14
Open

Update Voting Tutorial #376

joshuahannan opened this issue Feb 15, 2021 · 5 comments · May be fixed by onflow/flow-playground-tutorials#14
Assignees
Labels
Docs Site Improvements or additions to the documentation site Document A document or group of documents for publication on the Docs Site or elsewhere (eg totorial, blog) SC-Eng Issues that we want to see surfaced in SC-Eng ZH Board T-Documentation 📃

Comments

@joshuahannan
Copy link
Member

joshuahannan commented Feb 15, 2021

Issue To Be Solved

Update Voting and Kitty Hats Tutorial to:

  • Use more sophisticated composability features (run time types)
  • Explore a more realistic use-case of voting and composability
  • Use latest Cadence best practices and illustrate them via the tutorial
  • Fix bugs
  • Better explanations for features
@joshuahannan joshuahannan added Docs Site Improvements or additions to the documentation site Document A document or group of documents for publication on the Docs Site or elsewhere (eg totorial, blog) T-Documentation 📃 labels Feb 15, 2021
@joshuahannan joshuahannan self-assigned this Feb 15, 2021
@kerrywei kerrywei added the Developer Tool Team Track any developer tool related issues/PRs label Dec 2, 2021
@joshuahannan joshuahannan reopened this Jan 24, 2022
@joshuahannan joshuahannan added SC-Eng Issues that we want to see surfaced in SC-Eng ZH Board and removed Developer Tool Team Track any developer tool related issues/PRs labels Jan 24, 2022
@joshuahannan
Copy link
Member Author

Composable Resources

  • Potentially include a NFT contract that also includes a FT definition in the tutorial

Voting Tutorial

  • Work with DAO projects such as dapper collectives and Emerald City to see what they are doing
  • Try to make a more practical version of a DAO

@satyamakgec Is going to make a proposal for each tutorial and we'll discuss after then

@joshuahannan joshuahannan changed the title Update Voting and Kitty Hats Tutorials Update Voting Tutorial Jan 31, 2022
@satyamakgec
Copy link
Contributor

For voting -

I am thinking to write a MVP for the governance system, currently we have fungible token but it doesn't has the support for the governance system. So what I am planning to do is to extend the current fungible token and provide the support for the voting power and delegation of voting as well, However has the voting power can vote for a given proposal and every vote has its weight (~ voting power ~ balance the user posses at certain block.number).

It is itself a complete system beside the Dao itself not executing anything onchain once the proposal get passed. So the proposal will still be dummy but this is something we can add as an exercise to the learners.

For Composable Resources -

  • I don't have out of the box solution but I think a virtual land system may work where user could have different NFTs under a land. It is somewhat similar to what sandbox gaming project is supporting. Buy your land and then create buildings or whatnot over it. I can make it a small version of it.

Let me know what do you think ? Does both the approach seems too much or it is viable to add them as the tutorial ?

@joshuahannan
Copy link
Member Author

@satyamakgec I think that using the fungible token for a voting system is a great idea. I would just say to make sure that it can illustrate at least a few concepts that weren't covered enough in the previous tutorials, like maybe some more with capabilities and/or best practices. It is good that you want to include environment information like block number.

Can you post your suggestions for composable resources in that issue? #789
I think the land system could be fine. In terms of priority, I think the voting tutorial is a higher priority though, so I would focus on this one first.

@satyamakgec
Copy link
Contributor

Thanks, @joshuahannan I am working on the voting first maybe at today end of the day I will send you a sketch to approve.

@joshuahannan
Copy link
Member Author

Give high-level overview of the CLI and emulator
link to their documentation page
every time you use a feature of the CLI or emulator for the first time, mention it and explain what it is doing, what the arguments are, etc
Assume they know the basics of the standards, but still mention at the beginning of the tutorials that the users should understand them and give a link to them
explain pub(set)
Read through the other tutorials to remind yourself of what topics are covered, then look at the code again to figure out what in the voting tutorial hasn't already been covered, then make sure when you get to that point in the code, you explain it.
The tutorial should have a friendly tone and should not be just a list of steps to accomplish. If there is an interesting implication of a feature that you are explaining that isn't necessarily in the code itself, you are welcome to go off on a small tangent to explain that, which will hopefully spark some interest and creativity.
explain how flow.json works with CLI and how it is used in the tutorial
explain what happens each time you run a CLI command
After the governance token is introduced, include a section that describes what it is used for, highlights any new cadence feature that are used in it before getting to the administration contract

@ggpt-labs ggpt-labs linked a pull request Oct 26, 2022 that will close this issue
@joshuahannan joshuahannan self-assigned this Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Site Improvements or additions to the documentation site Document A document or group of documents for publication on the Docs Site or elsewhere (eg totorial, blog) SC-Eng Issues that we want to see surfaced in SC-Eng ZH Board T-Documentation 📃
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants