Governance tutorial extension WIP
This commit is contained in:
Julian Molina committed
1 parent
c143e518dd
commit
bb019a7ca2
23 files changed
+1467
-49
No files matched your search
+1276
File diff suppressed because it is too large.
Load diff
+1
-1
@@ -64,7 +64,7 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Data Mines are created by power users and contributed to the project (the ones shipping with the software). Users might create Data Mines for their personal use and never share them. However, if they share them, they receive SA tokens for that, and also for adapting and mantaining them, if necessary, for each new release."
|
||||
"text": "Data Mines are created by power users and contributed to the project (the ones shipping with the software). Users might create Data Mines for their personal use and never share them. However, if they share them, they receive SA Tokens for that, and also for adapting and mantaining them, if necessary, for each new release."
|
||||
},
|
||||
{
|
||||
"style": "Title",
|
||||
|
||||
+1
-1
@@ -265,7 +265,7 @@
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Step #30: Once you have successfully mapped the whole API and you have all the needed API Data Fetchers, Indicator Bots and Plotters tested, you are ready to share your API Map and Data Mine with the community as a plugin, and receive SA tokens in exchange for your contribution.",
|
||||
"text": "Step #30: Once you have successfully mapped the whole API and you have all the needed API Data Fetchers, Indicator Bots and Plotters tested, you are ready to share your API Map and Data Mine with the community as a plugin, and receive SA Tokens in exchange for your contribution.",
|
||||
"updated": 1622233875203
|
||||
},
|
||||
{
|
||||
|
||||
+4
-4
@@ -3,14 +3,14 @@
|
||||
"pageNumber": "3",
|
||||
"type": "Develop",
|
||||
"definition": {
|
||||
"text": "The Develop branch is the branch that is being used by developers involved in contributing to Superalgos. All the changes at this branch are sent to the Master branch everytime there is a new release. The Develop branch purpose is for accumulating changes at the codebase untiil the release date when all these changes are moved into the Master branch.",
|
||||
"updated": 1622467883706
|
||||
"text": "The Develop branch is the branch developers use to contribute to the codebase. Changes at this branch are merged into the Master branch upon each release or service pack. The purpose of the Develop branch is to accumulate changes at the codebase until the release date when changes are ready for merging.",
|
||||
"updated": 1630657066558
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Contributors working at this branch coordinate their here:",
|
||||
"updated": 1622468223194
|
||||
"text": "Contributors working at this branch Hang out in the Telegram Develop Group.",
|
||||
"updated": 1630657099841
|
||||
},
|
||||
{
|
||||
"style": "Link",
|
||||
|
||||
+2
-2
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "We have got a lot of exciting things to talk about, but I want to make sure you can follow along easily. ",
|
||||
"updated": 1629164474591
|
||||
"text": "We've got a lot of exciting things to talk about, but I want to make sure you can follow along easily.",
|
||||
"updated": 1630657385662
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
|
||||
+4
-4
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The SA token is a BEP20 token on the Binance Smart Chain (BSC). It represents your contributions to the Superalgos Project and Community. It is a way to reward the user base and grow the development pool.",
|
||||
"updated": 1630605572869
|
||||
"text": "The SA Token is a BEP20 token on the Binance Smart Chain (BSC). Your token holdings embody your contributions to the Superalgos Project and Community, as the token is used to reward the user base and grow the development pool.",
|
||||
"updated": 1630657545503
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
@@ -22,8 +22,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "This means that the more you contribute to the project and help others, the more tokens you will earn!",
|
||||
"updated": 1629164817915
|
||||
"text": "The more you contribute to the project and help others, the more tokens you will earn!",
|
||||
"updated": 1630657555715
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
|
||||
+2
-2
@@ -3,7 +3,7 @@
|
||||
"pageNumber": 5,
|
||||
"type": "Tutorial Step - With Tokens Comes Responsibility",
|
||||
"definition": {
|
||||
"text": "Holding tokens does more than just show commitment. SA tokens also confer Token Power!",
|
||||
"text": "Holding tokens does more than just show commitment. SA Tokens also confer Token Power!",
|
||||
"updated": 1630605735788,
|
||||
"icon": {
|
||||
"name": "governance",
|
||||
@@ -13,7 +13,7 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "The more tokens you hold the more influence you can have over the direction of the project. This means, by owning SA tokens, you hold the power to use those tokens to exert influence over what parts of the system will be developed and how the community will evolve.",
|
||||
"text": "The more tokens you hold the more influence you can have over the direction of the project. This means, by owning SA Tokens, you hold the power to use those tokens to exert influence over what parts of the system will be developed and how the community will evolve.",
|
||||
"updated": 1629165111109
|
||||
},
|
||||
{
|
||||
|
||||
+2
-2
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 8,
|
||||
"type": "Tutorial Step - What’s in a Profile?",
|
||||
"definition": {
|
||||
"text": "So what are we waiting for? Let’s get started! To participate in Governance you will first need a User Profile.",
|
||||
"updated": 1629163040597,
|
||||
"text": "So what are we waiting for? Let’s get started! To participate in Governance you will need a User Profile.",
|
||||
"updated": 1630657682741,
|
||||
"icon": {
|
||||
"name": "User\\user-profile",
|
||||
"project": "Governance"
|
||||
|
||||
+4
-4
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 9,
|
||||
"type": "Tutorial Step - Program Participation",
|
||||
"definition": {
|
||||
"text": "How you use your Token Power is defined within a number of different Programs within your profile hierarchy.",
|
||||
"updated": 1629163374967,
|
||||
"text": "How you use your Token Power is defined within a number of Governance Programs within your profile hierarchy.",
|
||||
"updated": 1630657749389,
|
||||
"icon": {
|
||||
"name": "User\\user-referrer",
|
||||
"project": "Governance"
|
||||
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "These programs help organize the types of development and community relationships you want to reward. ",
|
||||
"updated": 1629166399952
|
||||
"text": "These programs help organize the types of development and community relationships you want to reward.",
|
||||
"updated": 1630657777891
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
|
||||
+4
-4
@@ -13,13 +13,13 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Click the Add Profile Constructor button.",
|
||||
"updated": 1629163599518
|
||||
"text": "Click the <i>Add Profile Constructor</i> button.",
|
||||
"updated": 1630657850442
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Now position the resulting Profile Constructor node where it is easy to see.",
|
||||
"updated": 1629163626525
|
||||
"text": "Now position the resulting Profile Constructor node where it is easy to see and work with.",
|
||||
"updated": 1630657866373
|
||||
}
|
||||
]
|
||||
}
|
||||
+3
-3
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "It will also create a unique Binance Smart Chain wallet that is connected with your profile. We call it your Governance Address.",
|
||||
"updated": 1630606460047
|
||||
"text": "It will create a unique Binance Smart Chain wallet that is connected with your profile: your Governance Address.",
|
||||
"updated": 1630657968476
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
@@ -23,7 +23,7 @@
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Your Governance Address will allow you to receive the SA tokens you earn. Superalgos will read the balance of this address to become aware of the number of SA tokens you hold, and assign your profile an equivalent amount of Token Power.",
|
||||
"text": "Your Governance Address will allow you to receive the SA Tokens you earn. Superalgos will read the balance of this address to become aware of the number of SA Tokens you hold, and assign your profile an equivalent amount of Token Power.",
|
||||
"updated": 1630606362346
|
||||
}
|
||||
]
|
||||
|
||||
+2
-2
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 12,
|
||||
"type": "Tutorial Step - Pump that Heartbeat!",
|
||||
"definition": {
|
||||
"text": "Now let’s configure that Profile Constructor!",
|
||||
"updated": 1629167519082,
|
||||
"text": "Now let’s configure the Profile Constructor so that we may later build the profile!",
|
||||
"updated": 1630658339365,
|
||||
"icon": {
|
||||
"name": "configuration",
|
||||
"project": "Governance"
|
||||
|
||||
+2
-2
@@ -3,12 +3,12 @@
|
||||
"pageNumber": 13,
|
||||
"type": "Tutorial Step - Oh so Shiny",
|
||||
"definition": {
|
||||
"text": "We are almost there. Now click Build Profile and watch the magic happen. That’s right, you just created your profile!",
|
||||
"text": "We are almost there. Now click <i>Build Profile</i> and watch the magic happen. That’s right, you just created your profile!",
|
||||
"icon": {
|
||||
"name": "User\\user-profile",
|
||||
"project": "Governance"
|
||||
},
|
||||
"updated": 1629721281167
|
||||
"updated": 1630658421560
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
|
||||
+4
-4
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 14,
|
||||
"type": "Tutorial Step - Only You",
|
||||
"definition": {
|
||||
"text": "The profile constructor also did some work to make sure only you can change your profile.",
|
||||
"updated": 1629553865897,
|
||||
"text": "The Profile Constructor also did some work to make sure only you can change your profile.",
|
||||
"updated": 1630658478769,
|
||||
"icon": {
|
||||
"name": "User\\user-profile",
|
||||
"project": "Governance"
|
||||
@@ -13,8 +13,8 @@
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "A cryptographic message with your GitHub.com username has been signed with the private key corresponding to your governance address. This message will be stored in your User Profile so that we may authenticate it comes from you once you submit your profile as a plugin to the Governance Project.",
|
||||
"updated": 1629553908808
|
||||
"text": "A cryptographic message with your GitHub.com username has been signed with the private key corresponding to your Governance Address. This message will be stored in your User Profile so that we may authenticate it comes from you once you submit your profile as a plugin to the Governance Project.",
|
||||
"updated": 1630658507981
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
|
||||
+3
-3
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 15,
|
||||
"type": "Tutorial Step - Under the Hood",
|
||||
"definition": {
|
||||
"text": "Let's take a little closer look at the cryptographic signature in your new profile.",
|
||||
"updated": 1629554334739,
|
||||
"text": "Let's take a closer look at the cryptographic signature in your new profile.",
|
||||
"updated": 1630658552742,
|
||||
"icon": {
|
||||
"name": "User\\user-profile",
|
||||
"project": "Governance"
|
||||
@@ -17,7 +17,7 @@
|
||||
"updated": 1629554250933
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"style": "Note",
|
||||
"text": "Wow that’s a lot of numbers! Again, this is how the governance system will know that this User Profile belongs to the private key that signed the message, which in turn belongs to the address that will hold the tokens that confer your profile with Token Power.",
|
||||
"updated": 1629554289159
|
||||
}
|
||||
|
||||
+2
-2
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 16,
|
||||
"type": "Tutorial Step - Save the Key!",
|
||||
"definition": {
|
||||
"text": "Now that you have a new rocking Profile, let’s talk some more about that private key. ",
|
||||
"updated": 1629554694993,
|
||||
"text": "Now that you have a new rocking User Profile, let’s talk some more about that private key.",
|
||||
"updated": 1630658607513,
|
||||
"icon": {
|
||||
"name": "Key\\key-reference",
|
||||
"project": "Foundations"
|
||||
|
||||
+5
-5
@@ -3,8 +3,8 @@
|
||||
"pageNumber": 17,
|
||||
"type": "Tutorial Step - Profile Backup",
|
||||
"definition": {
|
||||
"text": "Later on, you will be rewarded with Superalgos SA Tokens to the address you just generated. But before that happens, you must safely store the private key that you will use to access the address.",
|
||||
"updated": 1629579328664,
|
||||
"text": "Your Superalgos SA Token rewards will go to the address you just generated, so you should safely store the private key that you will use to access the address.",
|
||||
"updated": 1630658720175,
|
||||
"icon": {
|
||||
"name": "Exchange\\exchange-account-asset",
|
||||
"project": "Foundations"
|
||||
@@ -12,9 +12,9 @@
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "At this point, Superalgos doesn’t offer a built-in solution to securely back up your private keys. All the system does is generate a BSC address / private key pair and deliver it in the configuration of the Profile Constructor node. It is up to you to decide how you are going to handle this sensitive information.",
|
||||
"updated": 1629578959187
|
||||
"style": "Important",
|
||||
"text": "Superalgos doesn’t offer a built-in solution to securely back up your private keys. The system generates a BSC address / private key pair and delivers it in the configuration of the Profile Constructor. It is up to you to decide how you are going to handle this sensitive information.",
|
||||
"updated": 1630658807597
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
|
||||
+6
-2
@@ -18,8 +18,12 @@
|
||||
},
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Find the Token Power Switch node under the User Profile node and click <i>Add Onboarding Programs</i> on the menu.",
|
||||
"updated": 1630606805313
|
||||
"text": "Find the Token Power Switch node under the User Profile node and click Add Onboarding Programs on the menu.",
|
||||
"updated": 1630658978533
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "The Onboarding Programs node should pop up as an offspring of the Token Power Switch."
|
||||
}
|
||||
]
|
||||
}
|
||||
+2
-2
@@ -23,8 +23,8 @@
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "Now you may get up to 1,000 SA tokens at the next Distribution Event and every other future release provided you submit your User Profile!",
|
||||
"updated": 1630607071137
|
||||
"text": "Just by deploying the program, you are all set to get up to 1,000 SA Tokens at the next Distribution Event and on every other future release provided that you submit your User Profile!",
|
||||
"updated": 1630659363719
|
||||
}
|
||||
]
|
||||
}
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"tutorial": "Creating Your User Profile Tutorial",
|
||||
"pageNumber": "21.1",
|
||||
"type": "Tutorial Step - How Github Works",
|
||||
"definition": {
|
||||
"text": "Github.com bumps up the search ranking of projects when they have many stars, forks, and people watching the repository!",
|
||||
"updated": 1630659929485,
|
||||
"icon": {
|
||||
"name": "Programs\\github-program",
|
||||
"project": "Governance"
|
||||
}
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "That is why we ask you to help in this manner! By completing those three tasks, you are effectively helping more developers find Superalgos, which is a win for everyone, as the more developers, the faster the project advances!",
|
||||
"updated": 1630660356226
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Now, this is how it works on the side of Superalgos:",
|
||||
"updated": 1630659982457
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "The system checks the repository and verifies if your Github account has a star, a fork, and/or a watch.",
|
||||
"updated": 1630660104845
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "There is a cap of SA 1,000 for each of these incentives. This means that you may get up to SA 3,000 if you maximize your participation.",
|
||||
"updated": 1630660329237
|
||||
}
|
||||
]
|
||||
}
|
||||
+30
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"tutorial": "Creating Your User Profile Tutorial",
|
||||
"pageNumber": "21.6",
|
||||
"type": "Tutorial Step - Low Hanging Fruit",
|
||||
"definition": {
|
||||
"text": "Now I'll hook you up with the Community Building Programs, which are also quite easy to set up and will earn you more tokens!",
|
||||
"updated": 1630660957861,
|
||||
"icon": {
|
||||
"name": "Programs\\community-building-programs",
|
||||
"project": "Governance"
|
||||
}
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Go to the Token Power Switch node and select <i>Add Comunity Building Programs</i> from the menu.",
|
||||
"updated": 1630661290597
|
||||
},
|
||||
{
|
||||
"style": "Note",
|
||||
"text": "Superalgos thrives through contributions and collaboration. We designed these programs to foster a community in which members are always ready to help and give back!",
|
||||
"updated": 1630661420122
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "These programs are a bit more elaborate in their workings... you'll love them!",
|
||||
"updated": 1630661576265
|
||||
}
|
||||
]
|
||||
}
|
||||
+34
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"tutorial": "Creating Your User Profile Tutorial",
|
||||
"pageNumber": "21.7",
|
||||
"type": "Tutorial Step - I'll Lay Out the Basics",
|
||||
"definition": {
|
||||
"text": "All Community Building Programs have two built-in types of incentives: a Tokens Bonus, and Tokens Awarded by the program.",
|
||||
"icon": {
|
||||
"name": "Programs\\community-building-programs",
|
||||
"project": "Governance"
|
||||
},
|
||||
"updated": 1630664341967
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "In general terms, this is how it works:",
|
||||
"updated": 1630664598834
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Tokens Bonus: It's an incentive to participate in the program. You earn these tokens simply by fulfilling the participation rules."
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "Tokens Awarded: These programs incentivize desirable behaviors. If you constructively participate in the Community, then you will earn more tokens!",
|
||||
"updated": 1630664896700
|
||||
},
|
||||
{
|
||||
"style": "Success",
|
||||
"text": "The interesting bit about these programs is that they reward chains of collaborations! Let's explore this concept within the Referral Program!",
|
||||
"updated": 1630664769086
|
||||
}
|
||||
]
|
||||
}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
{
|
||||
"tutorial": "Creating Your User Profile Tutorial",
|
||||
"pageNumber": "21.8",
|
||||
"type": "Tutorial Step - The Referrral Program",
|
||||
"definition": {
|
||||
"text": "The Referral Program incentivizes the promotion of the project, either by word-of-mouth or “en masse” through articles, social media posts, videos, and other forms of influencer marketing!",
|
||||
"updated": 1630665298091,
|
||||
"icon": {
|
||||
"name": "Programs\\referral-program",
|
||||
"project": "Governance"
|
||||
}
|
||||
},
|
||||
"paragraphs": [
|
||||
{
|
||||
"style": "Callout",
|
||||
"text": "Go to the Community Building Programs node and click <i>Add Referral Program</i>.",
|
||||
"updated": 1630665425190
|
||||
},
|
||||
{
|
||||
"style": "Text",
|
||||
"text": "Now, let's clarify what rules you must fulfill to earn your Tokens Bonus!"
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "You must deploy the program: Done!",
|
||||
"updated": 1630665468816
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "You must declare your referrer: We'll do that next!",
|
||||
"updated": 1630665632799
|
||||
},
|
||||
{
|
||||
"style": "List",
|
||||
"text": "You must drive Token Power to the program: Uuuhh... token power... that sounds neat! It is! You'll see!",
|
||||
"updated": 1630665776592
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in new issue
Block a user